Meshkit Dokumentation

This is intended to be a user oriented dokumentation for the Meshkit Firmware. It is in german language only at this point.

The documentation is not complete yet (not even nearly) and WIP. If you can help with making the Meshkit Documentation better then please do so. Thanks in advance.

It uses Sphinx to create the pages.

View documentation

The documentation can be viewed on the site Meshkit Documentation. It is automatically rebuild daily.

Contribute

To contribute you must first install some depencies, on Debian this can be done with the following commands:

aptitude install python-pygments
easy_install -U Sphinx
easy_install sphinxjp.themes.basicstrap

Note: use easy_install instead of the packages from the Debian repo because at least in wheezy the python-sphinx package had some bugs, e.g. didn't create the sidebar.

After that clone this repository and change into the meshkit-doc directory. All source files can be edited in the source/ folder. After you are done editing:

make html

to build the html pages. You will find them in build/html/.

If your changes look good push them to this repository or open a pull request.