search

mrz1988 / lilies

A cross-platform colored text formatting tool for the command line
MIT License
0 stars 0 forks source link

Fix up README.md #28

Closed mrz1988 closed 5 years ago

mrz1988 commented 5 years ago

The readme file should get moved to .rst format, and fixed up:

  1. Clean up the Getting Started section to be super brief, and use screenshots instead of code blocks (people need to see the colors!)
  2. Part out some of the Getting Started stuff into a set of basic walkthroughs in the /docs dir. This will get more fleshed out later.
  3. Remove the Demo section until we get real video walkthroughs or similar
  4. Link to the contributing.rst file
  5. Proofread and update anything that is stale
mrz1988 commented 5 years ago

Decided to leave it in markdown, since I like writing markdown much more than rst. API docs will likely be in RST and I see no reason to standardize across the codebase.

I fixed up the README quite a bit, including adding plenty of links, a demo screenshot, and cleaning up some of the nonsense. It can still get better, but for the scope of this issue, I'd consider this complete.