Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply new README design from brunildadosti branch #577

Merged
merged 1 commit into from Aug 2, 2019
Merged
Changes from all commits
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

Commit changes from brunildadosti's branch

  • Loading branch information...
samtuke committed Aug 2, 2019
commit 1025e349c79245f44b337f4a0c6028debcb1dec3
152 README.md
@@ -1,18 +1,34 @@
# phpList 3
<div align="center" width="100%">
<br/>
<img src="https://www.phplist.com/site/images/readme-images/logo-icon.svg" align="center" style="width:220px;">
</div>

#
[![Build Status](https://travis-ci.org/phpList/phplist3.svg?branch=master)](https://travis-ci.org/phpList/phplist3)
[![Stable release](https://img.shields.io/badge/stable-3.4.3-blue.svg)](https://sourceforge.net/projects/phplist/files/phplist/)
[![Stable release](https://img.shields.io/badge/stable-3.4.4-blue.svg)](https://sourceforge.net/projects/phplist/files/phplist/)
[![License](https://poser.pugx.org/phplist/phplist4-core/license.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)

Fully functional Open Source email marketing manager for creating, sending, integrating, and analysing email campaigns and newsletters: https://www.phplist.org
Fully functional Open Source email marketing manager for creating, sending, integrating, and analysing email campaigns and newsletters: [https://www.phplist.org](https://www.phplist.org)

phpList includes analytics, segmentation, content personalisation, bounce processing, plugin-based architecture, and multiple APIs. Used in 95 countries, available in 20 languages, and used to send more than 25 billion campaign messages in 2015.
phpList includes analytics, segmentation, content personalisation, bounce processing, plugin-based architecture, and multiple APIs. Used in 95 countries, available in 20 languages, and used to send more than 25 billion campaign messages in 2018.

Deploy it on your own server, or get a hosted account at http://phplist.com.

<div align="center" width="100%">
<a href="http://phplist.org/">Community</a> |
<a href="http://phplist.com/">Hosted</a> |
<a href="https://demo.phplist.org">Demo</a>
<br>
<img src="https://www.phplist.com/site/images/readme-images/panel.png" align="center" width="100%">
<br/>
</div>

---

### Features
<div align="center" width="100%">
<img src="https://www.phplist.com/site/images/readme-images/features_icon.svg" align="center" width="96px" />
<h3>Features</h3>
</div>

* Responsive web-based, and command-line interfaces
* Real-time analytics: track message responses and subscriber behaviour
@@ -29,97 +45,125 @@ Deploy it on your own server, or get a hosted account at http://phplist.com.

---

## Trying out phpList
<div align="center">
<img src="https://www.phplist.com/site/images/readme-images/get_phpList_icon.svg" align="center" width="96px" />
<h3>Get phpList</h3>
</div>

If you'd like to use phpList for your own campaigns, or you just want to try phpList out, there is no need to do all the work of installing it yourself. [phpList Hosted](https://phplist.com) is free to use, just [sign up](https://phplist.com/register) to get started.

If at a later time you do want to migrate from your own installation to phpList Hosted, or vice versa, your data can be migrated.

Alternatively, you can try out the latest phpList release at [phplist.org](https://demo.phplist.org/lists/admin/). This installation is wiped and refreshed every hour.

## Requirements
See [System requirements](https://resources.phplist.com/system/start)

## Development
See [phpList development](https://resources.phplist.com/develop/start)

## Installation
See the [Installation guide](https://www.phplist.org/manual/ch028_installation.xhtml)
<div align="center" style="max-width: 100%;">
<img src="https://www.phplist.com/site/images/readme-images/icon_1.svg" style=" display: inline-block;max-width: 96px;height: auto;width: 30%;margin: 1%;"/>
<img src="https://www.phplist.com/site/images/readme-images/icon_2.svg" style="display: inline-block;max-width: 96px;height: auto;width: 30%;margin: 1%; margin-left: 100px; margin-right: 100px;"/>
<img src="https://www.phplist.com/site/images/readme-images/icon_3.svg" style=" display: inline-block;max-width: 96px;height: auto;width: 30%;margin: 1%;"/>
</div>

<div align="center" width="100%">
<a href="#" style="text-decoration:none;font-size:22px;color:#000;">Requirements</a>
<a href="#" style="margin-right:90px;margin-left:60px; text-decoration:none;font-size:22px;color:#000;">Development</a>
<a href="#" style="text-decoration:none;font-size:22px;color:#000;">Installation</a>
</div>



## Upgrade
---

<div align="center" width="100%">
<img src="https://www.phplist.com/site/images/readme-images/upgrade_icon.svg" align="center" width="96px" />
<h3>Upgrade</h3>
</div>

### For users
#### For users

See [Upgrading a manual installation](https://www.phplist.org/manual/ch031_upgrading.xhtml)

### For developers
#### For developers

'Use translate.phplist.org to translate the phpList admin interface.'
How to upgrade from any previous version to the latest version


How to upgrade from any previous version to the latest version

Step 1. BACKUP your database
(e.g. # mysqldump -u[user] -p[password] [database] > phplist-backup.sql)
<div><img src="https://www.phplist.com/site/images/readme-images/1.svg" width="20px" style="margin-top:5px;"/> <strong>BACKUP your database</strong> (e.g. `mysqldump -u[user] -p[password] [database] > phplist-backup.sql`)</div><br/>

Step 2. Copy your old configured files to some safe place
<div><img src="https://www.phplist.com/site/images/readme-images/2.svg" width="20px"/> <strong>Copy your old configured files to some safe place</strong></div>

These files are:
lists/config/config.php
possibly lists/texts/english.inc or any other language.inc if you have edited it
* `lists/config/config.php`
* possibly `lists/texts/english.inc` or any other `language.inc` if you have edited it

Step 3. Copy the files from the tar file to your webroot.
<div><img src="https://www.phplist.com/site/images/readme-images/3.svg" width="20px"/> <strong>Copy the files from the tar file to your webroot.</strong></div>

You can copy everything in the "lists" directory in the tar file to your website.
To facilitate future upgrades, ie to make it easier for you to simply copy
everything I have now put the "configurable" files in their own directory. They
reside in "lists/config". This is hopefully going to be the directory that you can
keep between upgrades, and that will contain the only information that you want to be changed in order to make it work for your own site.
You can copy everything in the `lists` directory in the tar file to your website. To facilitate future upgrades, ie to make it easier for you to simply copy everything I have now put the "configurable" files in their own directory. They reside in "lists/config". This is hopefully going to be the directory that you can keep between upgrades, and that will contain the only information that you want to be changed in order to make it work for your own site.

Step 4. Copy your configuration files to lists/config or re-edit the new config file
sometimes new features are added to the config file, so it's better to use
the new config file and re-adapt it to your situation.
<img src="https://www.phplist.com/site/images/readme-images/4.svg" width="20px"/> <strong>Copy your configuration files to lists/config or re-edit the new config file sometimes new features are added to the config file, so it's better to use the new config file and re-adapt it to your situation.</strong>

An example .htaccess exists file in this directory. You should not allow
access to this directory from the webserver at all. The example will work with
apache.
An example .htaccess exists file in this directory. You should not allow access to this directory from the webserver at all. The example will work with apache.

You can overwrite the files that are there. They are example files.

Step 5. Go to http://yourdomain/lists/admin/ and choose the Upgrade link

Step 6. Click the link on this page.
<div><img src="https://www.phplist.com/site/images/readme-images/5.svg" width="20px"/> Go to `http://yourdomain/lists/admin/` and choose the 'Upgrade' link</div> <br/>

<img src="https://www.phplist.com/site/images/readme-images/6.svg" width="20px"/><strong> Click the link on this page.</strong><br/>
This process may take quite a while if your database is large. Don't interrupt it.

## Issues
#

Report issues to [Mantis issue tracker](https://mantis.phplist.org/bug_report_page.php) (select project *phpList*)
<div align="center" width="100%">
<img src="https://www.phplist.com/site/images/readme-images/issues_icon.svg" align="center" width="96px" />
<h3>Issues</h3>
<p>Report issues to <a href="https://mantis.phplist.org/bug_report_page.php">Mantis issue tracker</a> (select project phpList 3 application)<br>
'Please don't use GitHub issues'.</p>
</div>

## Languages, Info files and Contextual help on phpList
In the directory `phplists/lists/texts` you will find existing translations of the public
pages of phpList. You can use them in your config file to make the frontend of the system
appear in the language of your choice.
#

In the config file there are a lot of choices to make about your particular
installation. Make sure to read it carefully and step by step work your way through
it. A lot of information is provided with each step.
<div align="center" width="100%">
<img src="https://www.phplist.com/site/images/readme-images/languages_icon.svg" align="center" width="96px" />
<h3>Languages, Info files and Contextual help</h3>
</div>

The GitHub repo for the /texts directory [here](Contextual help).
In the directory `phplists/lists/texts` you will find existing translations of the public pages of phpList. You can use them in your config file to make the frontend of the system appear in the language of your choice.

To use info files in a local development copy of phpList you should get/clone the repo [here](https://github.com/phpList/phplist-lan-info) and place it on /lists/admin/info. The same applies for the ["Help" text repo](https://github.com/phpList/phplist-lan-help/) that should be placed into public_html/lists/texts
In the config file there are a lot of choices to make about your particular installation. Make sure to read it carefully and step by step work your way through it. A lot of information is provided with each step.

## Themes
#

<div align="center" width="100%">
<img src="https://www.phplist.com/site/images/readme-images/theme-icon.png" align="center" width="96px" />
<h3>Themes</h3>
</div>

Since version 3.3.0 phpList offers you the possibility to switch among two themes:
1. [Dressprow](https://github.com/phpList/phplist-ui-dressprow);
2. [Trevelin](https://github.com/phpList/phplist-ui-bootlist);

- [Dressprow](https://github.com/phpList/phplist-ui-dressprow)
- [Trevelin](https://github.com/phpList/phplist-ui-bootlist)

While when you install phpList on production since 3.3.1 the default theme is Trevelin, on the development copy phpList will run a copy of Dressprow.
To get the latest copy of each theme you should clone them individually into public_html/lists/admin/ui/
For the prerequisites of each and Installation guide on your development copy make sure you check the README files of the repos.

## Code of Conduct
This project adheres to a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project and its community, you are expected to uphold
this code.
#

<div align="center" width="100%">
<img src="https://www.phplist.com/site/images/readme-images/code_of_conduct_icon.svg" align="center" width="96px" />
<h3>Code of Conduct</h3>
</div>

This project adheres to a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project and its community, you are expected to uphold this code.

#

<div align="center" width="100%">
<img src="https://www.phplist.com/site/images/readme-images/license_icon.svg" align="center" width="96px" />
<h3>License</h3>
</div>

## License
phpList 3 is licensed under the terms of the AGPLv3 Open Source license and is available free of charge.
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.