1
0
mirror of https://github.com/danog/PHP-Parser.git synced 2024-11-30 04:19:30 +01:00

Add documentation TOC to readme

This commit is contained in:
Nikita Popov 2015-03-10 21:32:21 +01:00
parent 0c34706799
commit 5567f0ab3b

View File

@ -4,7 +4,7 @@ PHP Parser
This is a PHP 5.2 to PHP 5.6 parser written in PHP. Its purpose is to simplify static code analysis and
manipulation.
[**Documentation for version 1.0.x**][doc_master] (stable; for running on PHP >= 5.3).
[**Documentation for version 1.x**][doc_master] (stable; for running on PHP >= 5.3).
[Documentation for version 0.9.x][doc_0_9] (unsupported; for running on PHP 5.2).
@ -70,7 +70,18 @@ programming errors or security issues).
Additionally, you can convert a syntax tree back to PHP code. This allows you to do code preprocessing
(like automatedly porting code to older PHP versions).
So, that's it, in a nutshell. You can find everything else in the [docs][doc_master].
Documentation
-------------
1. [Introduction](doc/0_Introduction.markdown)
2. [Installation](doc/1_Installation.markdown)
3. [Usage of basic components](doc/2_Usage_of_basic_components.markdown)
4. [Other node tree representations](doc/3_Other_node_tree_representations.markdown)
5. [Code generation](doc/4_Code_generation.markdown)
Component documentation:
1. [Lexer](doc/component/Lexer.markdown)
[doc_0_9]: https://github.com/nikic/PHP-Parser/tree/0.9/doc
[doc_master]: https://github.com/nikic/PHP-Parser/tree/master/doc