eddieantonio / eddieantonio/ocreval
Create online documentation for accuracy program
Open
good first issue
help wanted
- Dominant language
- C
- Stars
- 60
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
Create documentation for the `accuracy` program with:
1. name
2. synopsis
3. description
4. options
5. examples
Create the documentation in `docs/accuracy.md` and link to it from `README.md`!
Addresses #6.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading the `accuracy` program and the existing `README.md` to understand its usage and documentation style. Create `docs/accuracy.md` with the name, synopsis, description, options, and examples, then link it from `README.md`; the documentation should cover how to use the program.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100