Update readme with usage of setup.sh
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 625
- Forks
- 103
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 1
Description
Took me a while to notice the note stating that the binaries are not included in the image anymore. Would be nice to update the README to have instructions on how to setup the image.
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 reading the README and setup.sh to understand the current image setup flow and the note about binaries no longer being included. Update the README with clear instructions for using setup.sh to set up the image, then verify that the documented steps match the script.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, shell
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100