Improve readme file
Open
- Dominant language
- Ruby
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Thank you for making this template. However, some issues when trying out this:
The git command did not work at first, the clone should go before --depth argument.
The bin/setup, bin/server and bin/middleman needed special permissions, had to use chmod +x
Would appreciate more detail instructions.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading the README and checking the documented git clone command plus the bin/setup, bin/server, and bin/middleman scripts. Verify the setup steps and executable-permission requirements, then update the README so a fresh user can follow the instructions successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100