This is the repository where the ReadOnly documentation is held.

The latest may be viewed by visiting ReadOnlyDocs

Licensing

The Documentation is licensed under the GNU General Public License v3.0.

Local Environment

You can setup an environment so you can instantly see the changes that have been made to the docs.

1. Install Python 3
2. Install node.js

In terminal or the command line, within the directory containing this README, run the following commands:

npm install -g gulp
npm install
pip install -r requirements.txt
gulp

Your browser should open to reveal the docs. When you make a change to the documentation, the docs should refresh in the browser (possibly after a few seconds).