Work on documentation

Part of making any piece of software accessible is the use of clear documentation. I had originally planned to do it all automatically using Python’s docstrings and some scripts but I’ve now come to the conclusion that I’m better off doing it by hand and making it as simple as possible. My aim is to write up the basic documentation of how to use FoxDot by the end of the summer and add some more technical description of what’s going on behind the scenes by the new year. A lot of it will be grabbed from the GitHub and wherever else I’ve been writing things down but it’ll be good to have it all in one place.

 

Ryan

Leave a Reply