Skip to content

Commit 629f0b4

Browse files
authored
Merge pull request #93 from javiereguiluz/patch-1
Add a README file
2 parents dbb0391 + fc242eb commit 629f0b4

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Symfony Docs Builder
2+
====================
3+
4+
This project is used to build the [Symfony Documentation][1] both in
5+
https://symfony.com and the Continuous Integration service used in the Symfony
6+
Docs repository.
7+
8+
This project is considered **an internal tool** and therefore, you
9+
**shouldn't use this project in your application**. Unlike the rest of the
10+
Symfony projects, this repository doesn't provide any support and it doesn't
11+
guarantee backward compatibility either. Any or the entire project can change,
12+
or even disappear, at any moment without prior notice.
13+
14+
If you are looking for a project to build your reStructuredText documentation
15+
in PHP, use [Doctrine RST parser][2] (which is also used by this project internally).
16+
17+
[1]: https://github.com/symfony/symfony-docs
18+
[2]: https://github.com/doctrine/rst-parser

0 commit comments

Comments
 (0)