diff --git a/README.md b/README.md index 585350ef44a93..36a466f2c8f04 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,74 @@ -README -====== +

+ +

-What is Symfony? ------------------ - -Symfony is a PHP 5.3 full-stack web framework. It is written with speed and -flexibility in mind. It allows developers to build better and easy to maintain -websites with PHP. - -Symfony can be used to develop all kind of websites, from your personal blog -to high traffic ones like Dailymotion or Yahoo! Answers. - -Requirements ------------- - -Symfony is only supported on PHP 5.3.9 and up. - -Be warned that PHP 5.3.16 has a major bug in the Reflection subsystem and is -not suitable to run Symfony (https://bugs.php.net/bug.php?id=62715) +[Symfony][1] is a **PHP framework** for web applications and a set of reusable +**PHP components**. Symfony is used by thousands of web applications (including +BlaBlaCar.com and Spotify.com) and most of the [popular PHP projects][2] (including +Drupal and Magento). Installation ------------ -The best way to install Symfony is to use the [official Symfony Installer][7]. -It allows you to start a new project based on the version you want. +* [Install Symfony][4] with Composer or with our own installer (see + [requirements details][3]). +* Symfony follows the [semantic versioning][5] strictly, publishes "Long Term + Support" (LTS) versions and has a [release process][6] that is predictable and + business-friendly. Documentation ------------- -The "[Quick Tour][1]" tutorial gives you a first feeling of the framework. If, -like us, you think that Symfony can help speed up your development and take -the quality of your work to the next level, read the official -[Symfony documentation][2]. +* Read the [Getting Started guide][7] if you are new to Symfony. +* Try the [Symfony Demo application][23] to learn Symfony in practice. +* Master Symfony with the [Guides and Tutorials][8], the [Components docs][9] + and the [Best Practices][10] reference. -Contributing ------------- - -Symfony is an open source, community-driven project. If you'd like to contribute, -please read the [Contributing Code][3] part of the documentation. If you're submitting -a pull request, please follow the guidelines in the [Submitting a Patch][4] section -and use [Pull Request Template][5]. - -Community Reviews ------------------ +Community +--------- -If you don't feel ready to contribute code or patches, reviewing issues and pull -requests can be a great start to get involved and give back. In fact, people who -"triage" issues are the backbone to Symfony's success! -More information can be found in the [Community Reviews][8] guide. +* [Join the Symfony Community][11] and meet other members at the [Symfony events][12]. +* [Get Symfony support][13] on StackOverflow, Slack, IRC, etc. +* Follow us on [GitHub][14], [Twitter][15] and [Facebook][16]. -Running Symfony Tests ----------------------- - -Information on how to run the Symfony test suite can be found in the -[Running Symfony Tests][6] section. +Contributing +------------ -[1]: https://symfony.com/doc/current/quick_tour/index.html -[2]: https://symfony.com/doc/current/ -[3]: https://symfony.com/doc/current/contributing/code/index.html -[4]: https://symfony.com/doc/current/contributing/code/patches.html#check-list -[5]: https://symfony.com/doc/current/contributing/code/patches.html#make-a-pull-request -[6]: https://symfony.com/doc/master/contributing/code/tests.html -[7]: https://symfony.com/doc/current/book/installation.html#installing-the-symfony-installer -[8]: https://symfony.com/doc/current/contributing/community/reviews.html +Symfony is an Open Source, community-driven project with thousands of +[contributors][19]. Join them [contributing code][17] or [contributing documentation][18]. + +Security Issues +--------------- + +If you discover a security vulnerability within Symfony, please follow our +[disclosure procedure][20]. + +About Us +-------- + +Symfony development is sponsored by [SensioLabs][21], lead by the +[Symfony Core Team][22] and supported by [Symfony contributors][19]. + +[1]: https://symfony.com +[2]: https://symfony.com/projects +[3]: https://symfony.com/doc/current/reference/requirements.html +[4]: https://symfony.com/doc/current/setup.html +[5]: http://semver.org +[6]: https://symfony.com/doc/current/contributing/community/releases.html +[7]: https://symfony.com/doc/current/page_creation.html +[8]: https://symfony.com/doc/current/index.html +[9]: https://symfony.com/doc/current/components/index.html +[10]: https://symfony.com/doc/current/best_practices/index.html +[11]: https://symfony.com/community +[12]: https://symfony.com/events/ +[13]: https://symfony.com/support +[14]: https://github.com/symfony +[15]: https://twitter.com/symfony +[16]: https://www.facebook.com/SymfonyFramework/ +[17]: https://symfony.com/doc/current/contributing/code/index.html +[18]: https://symfony.com/doc/current/contributing/documentation/index.html +[19]: https://symfony.com/contributors +[20]: https://symfony.com/security +[21]: https://sensiolabs.com +[22]: https://symfony.com/doc/current/contributing/code/core_team.html +[23]: https://github.com/symfony/symfony-demo