Installation

Preconditions:

• You have a project hosted on Github
• You have documentation for the project written on the GitHub wiki
• The wiki pages are categorised (if necessary) using the page title form: category--pageTitle
• You have a local version of the project on a server that can understand PHP

1. Copy the code into its own directory (probably called "docs") in your main project
2. Go to project/docs using a browser (assumes you've got a server running PHP)
3. Confirm that the docs display the documentation for this code
4. Delete the wiki directory inside the docs directory (this is simply a copy of this documentation)
5. Integrate your project's Github wiki into the main project as a submodule inside the docs directory. See http://stackoverflow.com/questions/6941688/how-to-integrate-a-github-wiki-into-the-main-project
6. Set the configuration variables in config.php
7. Add some wiki pages to your GitHub project
8. Use your GitHub client to pull the wiki pages into the sub-module, and then the updated sub-module into the main project.