This document provides extra background and serves as a companion to the RChain-Architecture documentation
This project uses Sphinx (http://www.sphinx-doc.org/en/stable/index.html) to build html that is published to Read the Docs. To run this documentation on your computer, you should do the following:
- Python 2.6 or later
- git
For OSX/Linux users (based on instructions here: https://read-the-docs.readthedocs.org/en/latest/getting_started.html)
- From command line:
sudo pip install sphinx
For Windows users:
- In a terminal window, go to the cloned directory.
make html
cd build/html
open index.html
(open in web browser)- Tip: each time you run
make html
, just reload your browser to view changes