Any help with keeping this documentation up to date is much appreciated! Click here for more info about editing the documentation.
You can edit any file easily right here on GitHub. All you need is a GitHub
account. You can navigate to a file you want to edit via the file tree and
Edit button after selecting a file. We use Markdown syntax for
all documentation pages.
The webpages can be generated in the local directory
out using the
Gradle build script in the project root. If you have Gradle and the other
dependencies installed you only need to run Gradle using a terminal in the
project root. The script will do the rest.
The build script runs a Python script named
tools/mdwrapper.py on all
Markdown files (
*.md) in the
docs directory. Before the python script is
run some special tokens such as
%VERSION% are replaced with the values listed
version.properties file. The build script then creates thumbnails for
the gallery and finally copies all files in the
directories into the output directory.
After you have run the build script you will need a web server to serve the
pages in the
out directory in order to get them to render correctly in the
web browser. One of the simplest ways to set this up, if you have NodeJS and
NPM installed, is to run the following commands:
$ npm install http-server -g $ cd out $ http-server -o --cors
Another way to do this with nodejs is with your own small nodejs web server script.
The build script
build.gradle requires Gradle to run.
Python and python-markdown are required to generate the documentation pages.
pip install markdown
The Python Imaging Library (PIL) is required to create thumbnail images for the gallery. PIL can be installed by the command
pip install pil
Alternatively, for Windows users, you can download Pillow from here.