add README
Opened this issue · 2 comments
whoburg commented
add README
bqpd commented
README README
This file serves as an introduction to the repository, displaying on the root github page below the code. The prominent but ancillary position of a README encourages writing it in a welcoming but organized tone.
READMEs sometimes use passive voice, but we're of two minds about that: it's a rare chance to speak directly to advanced users.
Markdown formatting
If the filename is README.md (instead of just a text file calledREADME), then github will parse it as a markdown file. Among other things, this allows for:
- nice headers and subheaders
- testing badges
- bulleted lists
- 😉
1ozturkbe commented
@bqpd there is some low hanging fruit here. Can either you or @mjburton11 at least make a list of the models in README.md so it is clear what is in there? Seems pretty basic.