We have decided to try and use the github '*.md' pages to document the design. The intention is to have the documentation in one place, close to the source, and always reflect the current build status.
Everything. At this stage we want to draw a line in the sand and document everything we know about the project. This includes:
- how-to guides
- how software is developed
- how hardware is connected
- how to use/develop
- etc
-
git uses the markdown language, some online pages describing the format can be found here: https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/ https://guides.github.com/features/mastering-markdown/
-
a suggested workflow for modifying/adding pages is:
-
clone the repo,
-
edit the .md file,
-
view the rendered page in your browser using 'grip' (see below),
-
re-edit the .md file,
-
re-view the rendered page (and loop 4-5 until it looks nice),
-
commit the file locally and push to the repo.
-
grip can be found here: https://github.com/joeyespo/grip
-
install the python-installer
sudo apt-get install python-pip -
clone the repo
git clone https://github.com/joeyespo/grip -
cd into the base dir
cd grip -
install grip
sudo python setup.py install -
grip can now be run from your working directory
-
navigate to working directory
cd <mega65>/mega65-core/doc -
start grip rendering pages
grip index.md & -
in browser, goto http://localhost:6419/ where grip is rendering the index.md file
-
to stop grip
killall grip
The End.