lethalbit / lethalbit/Slice-N-Splice
Write initial usage documentation
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- C++
- Stars
- 6
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Currently the only documentation is a bunch of header comments and an empty manpage, before the 1.0 release the bulk of the user-facing documentation should be written and checked.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing header comments and the empty manpage to identify the available user-facing material and missing usage information. Write and check the bulk of the documentation needed before the 1.0 release; done means users can understand how to use the project from the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100