coderkun/questlab
Watch
1
0
Fork
You've already forked questlab
 0
Code Issues 15 Pull requests Projects Releases Wiki Activity

Add basic Technical Documentation page

coderkun 2016-10-31 22:35:02 +01:00
commit 16f0542b81
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Technical-Documentation.md Normal file

@ -0,0 +1,11 @@
The application uses [phpDocumentor](https://www.phpdoc.org) 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.