1 Technical Documentation

coderkun edited this page 2016-10-31 22:35:02 +01:00

Table of Contents

• Generate documentation
• Read documentation

The application uses phpDocumentor to generate Technical/API documentation.

Generate documentation

Just run the following command in the root directory of the project.

$ phpdoc

Read documentation

After generation the documentation is stored in the doc folder. Just open doc/index.html with any web browser to read it.