README isn't clear, that you require "zsh" for these to work
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 7.8k
- Forks
- 3.2k
- PR merge metrics
- No merged PRs in 30d
Description
Hey Mate,
This is an amazing repo! I love the file structure you've made and am impressed by the ease of use.
Problem
The only thing that got me was running the thing! I know it's small, but it doesn't mention that you require zsh for this to function. The problem is the install script scripts/bootstrap works in bash and I assumed all dotfiles would too.
Just a small change in the README file saying you need zsh installed as default shell would help this for other noobs like me 👌
Cheers,
Ben
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 with the README and inspect scripts/bootstrap to confirm the shell requirement described in the issue. Update the README to state that zsh must be installed and set as the default shell; it is done when a new user can see this requirement before running the dotfiles.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash, zsh
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100