Skip to content
This repository was archived by the owner on Nov 27, 2020. It is now read-only.

Removing installation instructions #751

Merged
merged 1 commit into from
Dec 8, 2014
Merged

Removing installation instructions #751

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 18 additions & 119 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,117 +4,23 @@ Symfony Standard Edition
Welcome to the Symfony Standard Edition - a fully-functional Symfony2
application that you can use as the skeleton for your new applications.

This document contains information on how to download, install, and start
using Symfony. For a more detailed explanation, see the [Installation][1]
chapter of the Symfony Documentation.

1) Installing the Standard Edition
----------------------------------

When it comes to installing the Symfony Standard Edition, you have the
following options.

### Use Composer (*recommended*)

As Symfony uses [Composer][2] to manage its dependencies, the recommended way
to create a new project is to use it.

If you don't have Composer yet, download it following the instructions on
http://getcomposer.org/ or just run the following command:

curl -s http://getcomposer.org/installer | php

Then, use the `create-project` command to generate a new Symfony application:

php composer.phar create-project symfony/framework-standard-edition path/to/install

Composer will install Symfony and all its dependencies under the
`path/to/install` directory.

### Download an Archive File

To quickly test Symfony, you can also download an [archive][3] of the Standard
Edition and unpack it somewhere under your web server root directory.

If you downloaded an archive "without vendors", you also need to install all
the necessary dependencies. Download composer (see above) and run the
following command:

php composer.phar install

2) Checking your System Configuration
-------------------------------------

Before starting coding, make sure that your local system is properly
configured for Symfony.

Execute the `check.php` script from the command line:

php app/check.php

The script returns a status code of `0` if all mandatory requirements are met,
`1` otherwise.

Access the `config.php` script from a browser:

http://localhost/path/to/symfony/app/web/config.php

If you get any warnings or recommendations, fix them before moving on.

3) Browsing the Demo Application
--------------------------------

Congratulations! You're now ready to use Symfony.

From the `config.php` page, click the "Bypass configuration and go to the
Welcome page" link to load up your first Symfony page.

You can also use a web-based configurator by clicking on the "Configure your
Symfony Application online" link of the `config.php` page.

To see a real-live Symfony page in action, access the following page:

web/app_dev.php/demo/hello/Fabien

4) Getting started with Symfony
-------------------------------

This distribution is meant to be the starting point for your Symfony
applications, but it also contains some sample code that you can learn from
and play with.

A great way to start learning Symfony is via the [Quick Tour][4], which will
take you through all the basic features of Symfony2.

Once you're feeling good, you can move onto reading the official
[Symfony2 book][5].

A default bundle, `AcmeDemoBundle`, shows you Symfony2 in action. After
playing with it, you can remove it by following these steps:

* delete the `src/Acme` directory;

* remove the routing entry referencing AcmeDemoBundle in `app/config/routing_dev.yml`;

* remove the AcmeDemoBundle from the registered bundles in `app/AppKernel.php`;

* remove the `web/bundles/acmedemo` directory;

* empty the `security.yml` file or tweak the security configuration to fit
your needs.
For details on how to download and get started with Symfony, see the
[Installation][1] chapter of the Symfony Documentation.

What's inside?
---------------
--------------

The Symfony Standard Edition is configured with the following defaults:

* Twig is the only configured template engine;
* An AppBundle you can use to start coding;

* Doctrine ORM/DBAL is configured;
* Twig as the only configured template engine;

* Swiftmailer is configured;
* Doctrine ORM/DBAL;

* Annotations for everything are enabled.
* Swiftmailer;

* Annotations enabled for everything.

It comes pre-configured with the following bundles:

Expand Down Expand Up @@ -147,24 +53,17 @@ It comes pre-configured with the following bundles:
* [**SensioGeneratorBundle**][13] (in dev/test env) - Adds code generation
capabilities

* **AcmeDemoBundle** (in dev/test env) - A demo bundle with some example
code

All libraries and bundles included in the Symfony Standard Edition are
released under the MIT or BSD license.

Enjoy!

[1]: http://symfony.com/doc/2.3/book/installation.html
[2]: http://getcomposer.org/
[3]: http://symfony.com/download
[4]: http://symfony.com/doc/2.3/quick_tour/the_big_picture.html
[5]: http://symfony.com/doc/2.3/index.html
[6]: http://symfony.com/doc/2.3/bundles/SensioFrameworkExtraBundle/index.html
[7]: http://symfony.com/doc/2.3/book/doctrine.html
[8]: http://symfony.com/doc/2.3/book/templating.html
[9]: http://symfony.com/doc/2.3/book/security.html
[10]: http://symfony.com/doc/2.3/cookbook/email.html
[11]: http://symfony.com/doc/2.3/cookbook/logging/monolog.html
[12]: http://symfony.com/doc/2.3/cookbook/assetic/asset_management.html
[13]: http://symfony.com/doc/2.3/bundles/SensioGeneratorBundle/index.html
[1]: http://symfony.com/doc/current/book/installation.html
[6]: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html
[7]: http://symfony.com/doc/current/book/doctrine.html
[8]: http://symfony.com/doc/current/book/templating.html
[9]: http://symfony.com/doc/current/book/security.html
[10]: http://symfony.com/doc/current/cookbook/email.html
[11]: http://symfony.com/doc/current/cookbook/logging/monolog.html
[12]: http://symfony.com/doc/current/cookbook/assetic/asset_management.html
[13]: http://symfony.com/doc/current/bundles/SensioGeneratorBundle/index.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noticed that you changed the versions to current, which I think is not a good idea. Reverting to the version of the branch.