## KMS Readme

Het Komma management systeem. 
Also see our [Website](https://www.komma.pro).

## Generating documentation
The system contains php docblocks in it's code which makes automatic document generation possible. Configure it as follows.

### Install doxygen
Doxygen is the tool that generates the documentation for us. Install it like so:

* Press *Command+Space* and type *Terminal* and press enter/return key.
* Run in terminal: *ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null* and press *enter/return key*.
If the screen prompts you to enter a password, please enter your Mac's user password to continue. When you type the password, it won't be displayed on screen, but the system would accept it. So just type your password and press *enter/return* key. Then wait for the command to finish.
* Run in terminal: *brew install doxygen*

### Generate the documentation via the terminal
* Use your terminal with the *doxygen doxygen_config* command in the root of the project to generate the documentation.
* You can also generate the documentation and automatically open it in chrome with *sh doxygenit.sh*

### Opening the documentation
The documentation will be available in the *kms_documentation* folder. Just open the index.html file in there and your good to go.