Skip to content

Commit a537dd5

Browse files
committed
Update the README contents
1 parent de31ae9 commit a537dd5

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@ Requirements
1616
Installation
1717
------------
1818

19-
[Download Symfony][4] to install the `symfony` binary on your computer and run
20-
this command:
19+
There are 3 different ways of installing this project depending on your needs:
20+
21+
**Option 1.** [Download Symfony CLI][4] and use the `symfony` binary installed
22+
on your computer to run this command:
2123

2224
```bash
2325
$ symfony new --demo my_project
2426
```
2527

26-
Alternatively, you can use Composer:
28+
**Option 2.** [Download Composer][6] and use the `composer` binary installed
29+
on your computer to run these commands:
2730

2831
```bash
2932
# you can create a new project based on the Symfony Demo project...
@@ -35,8 +38,8 @@ $ cd my_project/
3538
$ composer install
3639
```
3740

38-
If you want to test the demo without installing anything locally, you can also
39-
deploy it on Platform.sh, the official Symfony PaaS:
41+
**Option 3.** Click the following button to deploy this project on Platform.sh,
42+
the official Symfony PaaS, so you can try it without installing anything locally:
4043

4144
<p align="center">
4245
<a href="https://console.platform.sh/projects/create-project?template=https://raw.githubusercontent.com/symfonycorp/platformsh-symfony-template-metadata/main/template-metadata-demo.yaml&utm_content=symfonycorp&utm_source=github&utm_medium=button&utm_campaign=deploy_on_platform"><img src="https://platform.sh/images/deploy/lg-blue.svg" alt="Deploy on Platform.sh" width="180px" /></a>
@@ -45,8 +48,10 @@ deploy it on Platform.sh, the official Symfony PaaS:
4548
Usage
4649
-----
4750

48-
There's no need to configure anything to run the application. If you have
49-
[installed Symfony][4] binary, run this command:
51+
There's no need to configure anything before running the application. There are
52+
2 different ways of running this application depending on your needs:
53+
54+
**Option 1.** [Download Symfony CLI][4] and run this command:
5055

5156
```bash
5257
$ cd my_project/
@@ -55,9 +60,15 @@ $ symfony serve
5560

5661
Then access the application in your browser at the given URL (<https://localhost:8000> by default).
5762

58-
If you don't have the Symfony binary installed, run `php -S localhost:8000 -t public/`
59-
to use the built-in PHP web server or [configure a web server][3] like Nginx or
60-
Apache to run the application.
63+
**Option 2.** Use a web server like Nginx or Apache to run the application
64+
(read the documentation about [configuring a web server for Symfony][3]).
65+
66+
On your local machine, you can run this command to use the built-in PHP web server:
67+
68+
```bash
69+
$ cd my_project/
70+
$ php -S localhost:8000 -t public/
71+
```
6172

6273
Tests
6374
-----
@@ -74,3 +85,4 @@ $ ./bin/phpunit
7485
[3]: https://symfony.com/doc/current/setup/web_server_configuration.html
7586
[4]: https://symfony.com/download
7687
[5]: https://symfony.com/book
88+
[6]: https://getcomposer.org/

0 commit comments

Comments
 (0)