MobyGamer / total-dos-launcher

A system for easily loading and running thousands of DOS programs on vintage hardware
MIT License
108 stars 10 forks source link

Start official documentation #2

Open MobyGamer opened 7 years ago

MobyGamer commented 7 years ago

Create basic skeleton of documentation. This should be basic ReStructuredText so that the docs can be read on an actual DOS system without translation. (Nothing wrong with markdown, but it's slightly less readable as a bare source format.) Should probably use Sphinx to generate HTML/PDF/epub/etc.

Helpful references: https://daler.github.io/sphinxdoc-test/includeme.html http://lucasbardella.com/blog/2010/02/hosting-your-sphinx-docs-in-github # If going with dumb raw README.rst, https://github.com/jakubroztocil/httpie/blob/master/README.rst is a good reference for examples of formatting, images, and code blocks.

MobyGamer commented 6 years ago

Basic, functional documentation now exists in readme.rst. Leaving project open to investigate Sphinx options.