Edit the README.md file to reflect our example use cases so far

cedadev / checksit

File-checking made simple

BSD 3-Clause "New" or "Revised" License

1 stars 1 forks source link

Closed agstephens closed 1 month ago

agstephens commented 2 years ago

[x] look at cli_tests.txt
[x] for each test run:
- [x] write some text to explain what it does
- [x] include the example in a code block
[ ] maybe write additional sections for things that we need to add
[ ] review issues in the "To Document" column and make sure they are reflected in the examples in the README

joshua-hampton commented 2 years ago

In progress, within specs-fmt-checks-etc-hampton branch. Current progress in README

each of the main 4 sections of checksit has a description (some more full than others)
each flag (particularly within checksit check) has a description with an example

joshua-hampton commented 1 month ago

Marking as closed due to changes in README and additional documentation