Write a proper README
Open
Nobody has claimed this yet.
- Dominant language
- Linker Script
- Stars
- 12
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
In no particular order:
- Explain what slinky is
- List all the features
- How to use
- Link the changelog
- Mention semantic versioning
- How to install/build
- Link docs
- Link examples (maybe inside of docs)
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 repository's existing changelog, documentation, and examples, then use them to structure the README. Document what slinky is, its features, usage, installation/build steps, semantic versioning, and links to the changelog, docs, and examples. Done means the README covers each listed topic and the links work.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100