-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Revamped the README file #21744
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Revamped the README file #21744
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
7c78deb
Revamped the main README file
javiereguiluz d32bd87
Minor fixes
javiereguiluz 8ed1496
Reworded the introduction
javiereguiluz 2d2f17b
Removed the PHP version specifics
javiereguiluz 0bb6fe4
Fixed minor issues
javiereguiluz 9cf4dee
Added a reference to the Symfony Demo app
javiereguiluz ec8cc27
Reworded the contribution section
javiereguiluz fc77099
Minor improvement (probably the last one)
javiereguiluz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,65 +1,74 @@ | ||
README | ||
====== | ||
<p align="center"><a href="https://symfony.com" target="_blank"> | ||
<img src="https://symfony.com/logos/symfony_black_02.svg"> | ||
</a></p> | ||
|
||
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 | ||
------------ | ||
8000 |
|
|
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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I don't think it's about installation, rather about way of developing. I think it should be in different section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. This one is tricky. It's not about installation ... but it's about how are Symfony versions released ... which is what you really install/update/use. Creating a new section looked like too much for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So maybe rename section to
Installation & maintanance
?