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

Update README.md #8625

Merged
merged 1 commit into from Dec 19, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
73 changes: 34 additions & 39 deletions README.md
Expand Up @@ -34,26 +34,23 @@ Server configuration
To install PrestaShop 1.7, you need a web server running PHP 5.4+ and any flavor of MySQL 5.0+ (MySQL, MariaDB, Percona Server, etc.).

You will also need a database administration tool, such as phpMyAdmin, in order to create a database for PrestaShop.
We recommend the Apache or Nginx web servers (check out our [example Nginx configuration file][23]).
We recommend the Apache or Nginx web servers (check out our [example Nginx configuration file][21]).

You can find more information on the [System Administrator Guide][19].
You can find more information on the [System Administrator Guide][17].

If your host does not offer PHP 5 by default, you will find a few explanations about PHP 5 or the `.htaccess` file in [our documentation][3], with details for certain hosting services.

If you want your own store with nothing to download and install, you should use [PrestaShop Cloud][4], our 100% free and fully-hosted PrestaShop service: it lets you create your online store in less than 10 minutes without any technical knowledge. Learn more about the [difference between PrestaShop Cloud and PrestaShop Download][10].


Installation
--------

Once the files in the PrestaShop archive have been decompressed and uploaded on your hosting space, go to the root of your PrestaShop directory with your web browser, and the PrestaShop unzipper/installer will start automatically. Follow the instructions until PrestaShop is installed.

If you get any PHP error, it might be that you do not have PHP 5 on your web server, or that you need to activate it. See [this page for explanations about PHP 5][3], or contact your web host directly.
If you do not find any solution to start the installer, please post about your issue on [the PrestaShop forums][5].
If you do not find any solution to start the installer, please post about your issue on [the PrestaShop forums][4].

If you installed PrestaShop from GitHub:

* Install Composer ([https://getcomposer.org][22])
* Install Composer ([https://getcomposer.org][20])
* Then run:

>
Expand All @@ -62,26 +59,26 @@ If you installed PrestaShop from GitHub:
User documentation
--------

The official PrestaShop 1.7 documentation is available online [on its own website][6]
The official PrestaShop 1.7 documentation is available online [on its own website][5]

First-time users will be particularly interested in the following guides:
* [Getting Started][13]: How to install PrestaShop, and what you need to know.
* [User Guide][14]: All there is to know to put PrestaShop to good use.
* [Updating Guide][15]: Switching to the newest version is not trivial. Make sure you do it right.
* [Merchant's Guide][16]: Tips and tricks for first-time online sellers.
* The [FAQ][17] and the [Troubleshooting][18] pages should also be of tremendous help to you.
* [Getting Started][11]: How to install PrestaShop, and what you need to know.
* [User Guide][12]: All there is to know to put PrestaShop to good use.
* [Updating Guide][13]: Switching to the newest version is not trivial. Make sure you do it right.
* [Merchant's Guide][14]: Tips and tricks for first-time online sellers.
* The [FAQ][15] and the [Troubleshooting][16] pages should also be of tremendous help to you.


Contributing
--------

PrestaShop is an Open Source project, and it wouldn't be possible without the help of the [hundreds of contributors][21], who submitted improvements and bugfixes over the years. Thank you all!
PrestaShop is an Open Source project, and it wouldn't be possible without the help of the [hundreds of contributors][19], who submitted improvements and bugfixes over the years. Thank you all!

If you want to contribute code to PrestaShop, read the [CONTRIBUTING.md][7] file in this repository or read the [tutorials about contribution][8] on the documentation site.
If you want to contribute code to PrestaShop, read the [CONTRIBUTING.md][6] file in this repository or read the [tutorials about contribution][7] on the documentation site.

Current [Travis](https://travis-ci.org/) status: [![Travis](https://travis-ci.org/PrestaShop/PrestaShop.svg?branch=develop)](https://travis-ci.org/PrestaShop/PrestaShop) (The Unit Tests are being implemented, so the status might be broken).

If you want to help translate PrestaShop in your language, [join us on Crowdin][9]!
If you want to help translate PrestaShop in your language, [join us on Crowdin][8]!

Current Crowdin status (for 69 registered languages): [![Crowdin](https://crowdin.net/badges/prestashop-official/localized.png)](https://crowdin.net/project/prestashop-official)

Expand All @@ -108,15 +105,15 @@ Understanding a security issue means knowing how the attacker got in and hacked
Extending PrestaShop
--------

PrestaShop is a very extensible e-commerce platform, both through modules and themes. Developers can even override the default components and behaviors. Learn more about this using the [Developer Guide][11] and the [Designer Guide][12].
PrestaShop is a very extensible e-commerce platform, both through modules and themes. Developers can even override the default components and behaviors. Learn more about this using the [Developer Guide][9] and the [Designer Guide][10].

Themes and modules can be obtained (and sold!) from [PrestaShop Addons][20], the official marketplace for PrestaShop.
Themes and modules can be obtained (and sold!) from [PrestaShop Addons][18], the official marketplace for PrestaShop.


Community forums
--------

You can discuss about e-commerce, help other merchants and get help, and contribute to improving PrestaShop together with the PrestaShop community on [the PrestaShop forums][5].
You can discuss about e-commerce, help other merchants and get help, and contribute to improving PrestaShop together with the PrestaShop community on [the PrestaShop forums][4].


Getting support
Expand All @@ -130,23 +127,21 @@ Thank you for downloading and using the PrestaShop Open Source e-commerce soluti
[1]: https://www.prestashop.com/en/online-store-builder
[2]: https://www.prestashop.com/en/download
[3]: http://doc.prestashop.com/display/PS16/Misc.+information#Misc.information-ActivatingPHP5
[4]: https://www.prestashop.com
[5]: https://www.prestashop.com/forums/
[6]: http://doc.prestashop.com
[7]: CONTRIBUTING.md
[8]: http://doc.prestashop.com/display/PS16/Contributing+to+PrestaShop
[9]: https://crowdin.net/project/prestashop-official
[10]: https://www.prestashop.com/en/ecommerce-software
[11]: http://developers.prestashop.com/
[12]: http://developers.prestashop.com/
[13]: http://doc.prestashop.com/display/PS17/Getting+Started
[14]: http://doc.prestashop.com/display/PS17/User+Guide
[15]: http://doc.prestashop.com/display/PS17/Updating+PrestaShop
[16]: http://doc.prestashop.com/display/PS16/Merchant%27s+Guide
[17]: http://build.prestashop.com/news/prestashop-1-7-faq/
[18]: http://doc.prestashop.com/display/PS16/Troubleshooting
[19]: http://doc.prestashop.com/display/PS16/System+Administrator+Guide
[20]: https://addons.prestashop.com/
[21]: CONTRIBUTORS.md
[22]: https://getcomposer.org
[23]: docs/server_config/nginx.conf.dist
[4]: https://www.prestashop.com/forums/
[5]: http://doc.prestashop.com
[6]: CONTRIBUTING.md
[7]: http://doc.prestashop.com/display/PS16/Contributing+to+PrestaShop
[8]: https://crowdin.net/project/prestashop-official
[9]: http://developers.prestashop.com/
[10]: http://developers.prestashop.com/
[11]: http://doc.prestashop.com/display/PS17/Getting+Started
[12]: http://doc.prestashop.com/display/PS17/User+Guide
[13]: http://doc.prestashop.com/display/PS17/Updating+PrestaShop
[14]: http://doc.prestashop.com/display/PS16/Merchant%27s+Guide
[15]: http://build.prestashop.com/news/prestashop-1-7-faq/
[16]: http://doc.prestashop.com/display/PS16/Troubleshooting
[17]: http://doc.prestashop.com/display/PS16/System+Administrator+Guide
[18]: https://addons.prestashop.com/
[19]: CONTRIBUTORS.md
[20]: https://getcomposer.org
[21]: docs/server_config/nginx.conf.dist