diff --git a/README.md b/README.md index 4602c2aaa..d9a2eb458 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,17 @@ Requirements Installation ------------ -[Download Symfony][4] to install the `symfony` binary on your computer and run -this command: +There are 3 different ways of installing this project depending on your needs: + +**Option 1.** [Download Symfony CLI][4] and use the `symfony` binary installed +on your computer to run this command: ```bash $ symfony new --demo my_project ``` -Alternatively, you can use Composer: +**Option 2.** [Download Composer][6] and use the `composer` binary installed +on your computer to run these commands: ```bash # you can create a new project based on the Symfony Demo project... @@ -35,8 +38,8 @@ $ cd my_project/ $ composer install ``` -If you want to test the demo without installing anything locally, you can also -deploy it on Platform.sh, the official Symfony PaaS: +**Option 3.** Click the following button to deploy this project on Platform.sh, +the official Symfony PaaS, so you can try it without installing anything locally:

Deploy on Platform.sh @@ -45,8 +48,10 @@ deploy it on Platform.sh, the official Symfony PaaS: Usage ----- -There's no need to configure anything to run the application. If you have -[installed Symfony][4] binary, run this command: +There's no need to configure anything before running the application. There are +2 different ways of running this application depending on your needs: + +**Option 1.** [Download Symfony CLI][4] and run this command: ```bash $ cd my_project/ @@ -55,9 +60,15 @@ $ symfony serve Then access the application in your browser at the given URL ( by default). -If you don't have the Symfony binary installed, run `php -S localhost:8000 -t public/` -to use the built-in PHP web server or [configure a web server][3] like Nginx or -Apache to run the application. +**Option 2.** Use a web server like Nginx or Apache to run the application +(read the documentation about [configuring a web server for Symfony][3]). + +On your local machine, you can run this command to use the built-in PHP web server: + +```bash +$ cd my_project/ +$ php -S localhost:8000 -t public/ +``` Tests ----- @@ -74,3 +85,4 @@ $ ./bin/phpunit [3]: https://symfony.com/doc/current/setup/web_server_configuration.html [4]: https://symfony.com/download [5]: https://symfony.com/book +[6]: https://getcomposer.org/