greatscottgadgets / greatscottgadgets/hackrf
Add man pages for hackrf utilities
Open
documentation
enhancement
- Dominant language
- C
- Stars
- 8.1k
- Forks
- 1.7k
- Avg merge
- 15d 7h
- Merged PRs (30d)
- 1
Description
Having man pages for the hackrf utilities would be an improvement over the --help output. I highly suggest using one of the many utilities that can convert Markdown into Roff, and then commit the resulting Roff files.
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 hackrf utilities' existing --help output and the open pull request #1579. Determine which utilities need man pages, author the source content in Markdown, and convert it to committed Roff files. Done means the utilities have man pages that improve on their --help output.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 20/100