Readme should actually describe package usage
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 248
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Description
I.e. especially the two exposed runtimes in bin - `build-glyphs` (I can infer usage from https://github.com/antoinekahlouche/font-to-pbf but that's about all I can find on it) and `font-inspect`. From the README there is not even an indication these exist _at all_, much less on how to use them.
Contributor guide
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 with the README and inspect the two entry points named in the issue: bin/build-glyphs and bin/font-inspect. Check the usage information and the linked font-to-pbf project for the commands and inputs to document. Done means the README identifies both runtimes and explains how to use each.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100