From 16f0542b81e61988ba33dc17ef344ba751c0e0d6 Mon Sep 17 00:00:00 2001 From: coderkun Date: Mon, 31 Oct 2016 22:35:02 +0100 Subject: [PATCH] Add basic Technical Documentation page --- Technical-Documentation.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 Technical-Documentation.md diff --git a/Technical-Documentation.md b/Technical-Documentation.md new file mode 100644 index 0000000..768d5c3 --- /dev/null +++ b/Technical-Documentation.md @@ -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. \ No newline at end of file