8000 Revamped the README file · symfony/symfony@c7d30ca · GitHub
[go: up one dir, main page]

Skip to content

Commit c7d30ca

Browse files
javiereguiluzfabpot
authored andcommitted
Revamped the README file
1 parent 68d6415 commit c7d30ca

File tree

1 file changed

+61
-52
lines changed

1 file changed

+61
-52
lines changed

README.md

Lines changed: 61 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,74 @@
1-
README
2-
======
1+
<p align="center"><a href="https://symfony.com" target="_blank">
2+
<img src="https://symfony.com/logos/symfony_black_02.svg">
3+
</a></p>
34

4-
What is Symfony?
5-
-----------------
6-
7-
Symfony is a PHP 5.3 full-stack web framework. It is written with speed and
8-
flexibility in mind. It allows developers to build better and easy to maintain
9-
websites with PHP.
10-
11-
Symfony can be used to develop all kind of websites, from your personal blog
12-
to high traffic ones like Dailymotion or Yahoo! Answers.
13-
14-
Requirements
15-
------------
16-
17-
Symfony is only supported on PHP 5.3.9 and up.
18-
19-
Be warned that PHP 5.3.16 has a major bug in the Reflection subsystem and is
20-
not suitable to run Symfony (https://bugs.php.net/bug.php?id=62715)
5+
[Symfony][1] is a **PHP framework** for web applications and a set of reusable
6+
**PHP components**. Symfony is used by thousands of web applications (including
7+
BlaBlaCar.com and Spotify.com) and most of the [popular PHP projects][2] (including
8+
Drupal and Magento).
219

2210
Installation
2311
------------
2412

25-
The best way to install Symfony is to use the [official Symfony Installer][7].
26-
It allows you to start a new project based on the version you want.
13+
* [Install Symfony][4] with Composer or with our own installer (see
14+
[requirements details][3]).
15+
* Symfony follows the [semantic versioning][5] strictly, publishes "Long Term
16+
Support" (LTS) versions and has a [release process][6] that is predictable and
17+
business-friendly.
2718

2819
Documentation
2920
-------------
3021

31-
The "[Quick Tour][1]" tutorial gives you a first feeling of the framework. If,
32-
like us, you think that Symfony can help speed up your development and take
33-
the quality of your work to the next level, read the official
34-
[Symfony documentation][2].
22+
* Read the [Getting Started guide][7] if you are new to Symfony.
23+
* Try the [Symfony Demo application][23] to learn Symfony in practice.
24+
* Master Symfony with the [Guides and Tutorials][8], the [Components docs][9]
25+
and the [Best Practices][10] reference.
3526

36-
Contributing
37-
------------
38-
39-
Symfony is an open source, community-driven project. If you'd like to contribute,
40-
please read the [Contributing Code][3] part of the documentation. If you're submitting
41-
a pull request, please follow the guidelines in the [Submitting a Patch][4] section
42-
and use [Pull Request Template][5].
43-
44-
Community Reviews
45-
-----------------
27+
Community
28+
---------
4629

47-
If you don't feel ready to contribute code or patches, reviewing issues and pull
48-
requests can be a great start to get involved and give back. In fact, people who
49-
"triage" issues are the backbone to Symfony's success!
50-
More information can be found in the [Community Reviews][8] guide.
30+
* [Join the Symfony Community][11] and meet other members at the [Symfony events][12].
31+
* [Get Symfony support][13] on StackOverflow, Slack, IRC, etc.
32+
* Follow us on [GitHub][14], [Twitter][15] and [Facebook][16].
5133

52-
Running Symfony Tests
53-
----------------------
54-
55-
Information on how to run the Symfony test suite can be found in the
56-
[Running Symfony Tests][6] section.
34+
Contributing
35+
------------
5736

58-
[1]: https://symfony.com/doc/current/quick_tour/index.html
59-
[2]: https://symfony.com/doc/current/
60-
[3]: https://symfony.com/doc/current/contributing/code/index.html
61-
[4]: https://symfony.com/doc/current/contributing/code/patches.html#check-list
62-
[5]: https://symfony.com/doc/current/contributing/code/patches.html#make-a-pull-request
63-
[6]: https://symfony.com/doc/master/contributing/code/tests.html
64-
[7]: https://symfony.com/doc/current/book/installation.html#installing-the-symfony-installer
65-
[8]: https://symfony.com/doc/current/contributing/community/reviews.html
37+
Symfony is an Open Source, community-driven project with thousands of
38+
[contributors][19]. Join them [contributing code][17] or [contributing documentation][18].
39+
40+
Security Issues
41+
---------------
42+
43+
If you discover a security vulnerability within Symfony, please follow our
44+
[disclosure procedure][20].
45+
46+
About Us
47+
--------
48+
49+
Symfony development is sponsored by [SensioLabs][21], lead by the
50+
[Symfony Core Team][22] and supported by [Symfony contributors][19].
51+
52+
[1]: https://symfony.com
53+
[2]: https://symfony.com/projects
54+
[3]: https://symfony.com/doc/current/reference/requirements.html
55+
[4]: https://symfony.com/doc/current/setup.html
56+
[5]: http://semver.org
57+
[6]: https://symfony.com/doc/current/contributing/community/releases.html
58+
[7]: https://symfony.com/doc/current/page_creation.html
59+
[8]: https://symfony.com/doc/current/index.html
60+
[9]: https://symfony.com/doc/current/components/index.html
61+
[10]: https://symfony.com/doc/current/best_practices/index.html
62+
[11]: https://symfony.com/community
63+
[12]: https://symfony.com/events/
64+
[13]: https://symfony.com/support
65+
[14]: https://github.com/symfony
66+
[15]: https://twitter.com/symfony
67+
[16]: https://www.facebook.com/SymfonyFramework/
68+
[17]: https://symfony.com/doc/current/contributing/code/index.html
69+
[18]: https://symfony.com/doc/current/contributing/documentation/index.html
70+
[19]: https://symfony.com/contributors
71+
[20]: https://symfony.com/security
72+
[21]: https://sensiolabs.com
73+
[22]: https://symfony.com/doc/current/contributing/code/core_team.html
74+
[23]: https://github.com/symfony/symfony-demo

0 commit comments

Comments
 (0)
0