Rough out an explanatory readme

[ngraymon]

Gives basic idea of how to use driver.py and _glue_.py and "roughly" where things are structured in files and what the user should expect out of the program.

[ngraymon]

Some example repos:

• https://github.com/freeCodeCamp/freeCodeCamp
• https://github.com/satwikkansal/wtfpython
• https://github.com/DjangoEx/python-engineer-roadmap

And this repo with example of readme's might be good?:
https://github.com/othneildrew/Best-README-Template

[lhprice]

residual_term_builder (tempname)

About

Install

pip install (final name)

Usage

driver.py is the main argparse interface py driver.py -h

-t : provide truncations
-a, --ansatz : specify ansatz

explain 3 ansatz and their trunc keys

-es, --excited_state : by default this is True but if provided will only produce the ground state
-rf, --remove_f_terms : remove f terms (TODO: f terms explanation)
-c, --code : generate the python code files instead of the Latex
-lhs : Turn on the LHS generator for easier finding of dt/dtau (might need some advanced desc here)

On top of the driver explanation need to give a basic idea of glue so that one can create a "in-house" driver.py if they desire

[ngraymon]

Probably start by just copying the output of -h argument passed to driver.py
Maybe show that you "could" directly call generate_full_cc_latex from latex_full_cc.py but why would you want to?
Maybe mention that _glue_.py just contains some processing to check the input truncations and also to stitch together the filenames?

Maybe just saying that driver.py + _glue_.py are effectively user UI / interface to the actual package?
People are free to directly access the modules, but might run into errors if input args are not correctly formatted.

[ngraymon]

Making use of https://packagecontrol.io/packages/MarkdownPreview and https://packagecontrol.io/packages/MarkdownEditing