Skip to content

Commit b52175f

Browse files
committed
minor #676 Simplified the README instructions (javiereguiluz)
This PR was squashed before being merged into the master branch (closes #676). Discussion ---------- Simplified the README instructions This is needed because we're moving away from the Symfony Installer and we'll use Composer's create-project from now on. Commits ------- aeece08 Simplified the README instructions
2 parents b7f860d + aeece08 commit b52175f

File tree

1 file changed

+16
-44
lines changed

1 file changed

+16
-44
lines changed

README.md

Lines changed: 16 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -4,76 +4,48 @@ Symfony Demo Application
44
The "Symfony Demo Application" is a reference application created to show how
55
to develop Symfony applications following the recommended best practices.
66

7-
[![Build Status](https://travis-ci.org/symfony/symfony-demo.svg?branch=master)](https://travis-ci.org/symfony/symfony-demo)
8-
97
Requirements
108
------------
119

1210
* PHP 7.1.3 or higher;
1311
* PDO-SQLite PHP extension enabled;
14-
* and the [usual Symfony application requirements](https://symfony.com/doc/current/reference/requirements.html).
15-
16-
If unsure about meeting these requirements, download the demo application and
17-
browse the `http://localhost:8000/config.php` script to get more detailed
18-
information.
12+
* and the [usual Symfony application requirements][1].
1913

2014
Installation
2115
------------
2216

23-
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
24-
25-
First, install the [Symfony Installer](https://github.com/symfony/symfony-installer)
26-
if you haven't already. Then, install the Symfony Demo Application executing
27-
this command anywhere in your system:
17+
Execute this command to install the project:
2818

2919
```bash
30-
$ symfony demo
31-
32-
# if you're using Windows:
33-
$ php symfony demo
20+
$ composer create-project symfony/symfony-demo
3421
```
3522

36-
If the `demo` command is not available, update your Symfony Installer to the
37-
most recent version executing the `symfony self-update` command.
38-
39-
> **NOTE**
40-
>
41-
> If you can't use the Symfony Installer, download and install the demo
42-
> application using Git and Composer:
43-
>
44-
> $ git clone https://github.com/symfony/symfony-demo symfony_demo
45-
> $ cd symfony_demo/
46-
> $ composer install --no-interaction
23+
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
4724

4825
Usage
4926
-----
5027

51-
There is no need to configure a virtual host in your web server to access the application.
52-
Just use the built-in web server:
28+
There's no need to configure anything to run the application. Just execute this
29+
command to run the built-in web server and access the application in your
30+
browser at <http://localhost:8000>:
5331

5432
```bash
55-
$ cd symfony_demo/
33+
$ cd symfony-demo/
5634
$ php bin/console server:run
5735
```
5836

59-
This command will start a web server for the Symfony application. Now you can
60-
access the application in your browser at <http://localhost:8000>. You can
61-
stop the built-in web server by pressing `Ctrl + C` while you're in the
62-
terminal.
63-
64-
> **NOTE**
65-
>
66-
> If you want to use a fully-featured web server (like Nginx or Apache) to run
67-
> Symfony Demo application, configure it to point at the `web/` directory of the project.
68-
> For more details, see:
69-
> https://symfony.com/doc/current/cookbook/configuration/web_server_configuration.html
37+
Alternatively, you can [configure a fully-featured web server][2] like Nginx
38+
or Apache to run the application.
7039

71-
Testing
72-
-------
40+
Tests
41+
-----
7342

7443
Execute this command to run tests:
7544

7645
```bash
77-
$ cd symfony_demo/
46+
$ cd symfony-demo/
7847
$ ./vendor/bin/simple-phpunit
7948
```
49+
50+
[1]: https://symfony.com/doc/current/reference/requirements.html
51+
[2]: https://symfony.com/doc/current/cookbook/configuration/web_server_configuration.html

0 commit comments

Comments
 (0)