The best way to document what you're doing is in a jupyter notebook. If you've never used notebooks before, make sure you have it installed in whatever virtual environment you're using.
If you're using anaconda, from your kivy environment you'll want to conda install jupyter notebook. Otherwise, pip install jupyter notebook should work (for more details see http://jupyter.readthedocs.io/en/latest/install.html). Once it's installed, call jupyter notebook from the comand line and it will launch notebooks from your web browser of choice.
Esc+H, will give you access to the help menu with all the keyboard shortcuts. Learn these. Use them.
In short there are 2 main kinds of cells, Markdown (like this cell) and Code (like the one below this one). Shift+Enter will run any cells. Here's the basics that you'll want to know for documenting things.
The main point is to try and tell your story, including all the tears and blood as well as triumphs in the process.
You can use magics in the cell.
!: you can follow this magic up with any bash command you want. %load filename.ext: loads filename.ext into the cell. Warning: you'll want to be careful to change this to Markdown cell after you load it, when you load a kivy related file since the notebook will die on your kivy code. %%file filename.ext: (overwrites) filename.ext this will let you edit your code from a notebook if you want.
In [ ]:
!ls -la
You main use of the above will probably be to run your game eg. !python main.py (well, there's no main.py here...)
In [ ]:
%%file newfile.txt
Writing some stuff...
In [ ]:
# load file you just made.
%load newfile.txt
In [ ]:
%%file newfile.txt
Overwriting the text.
In [ ]:
#take a look at the changed file
%load newfile.txt
And you can include screenshots of your progress (you'll want screenshots of what your game looks like instead of this boring screenshot).
In [ ]:
%%html
<img src="assets/demo-screenshot.png" width=800 />
That's all for now! Let Amy know if you want to know how to do more :)
In [ ]: