docs: Homepage displays getting started info only for MacOS users using brew
- Dominant language
- Clojure
- Stars
- 558
- Forks
- 56
- PR merge metrics
- No merged PRs in 30d
Description
Right now the project homepage and README mention only how to use `neil` tool to start a project. Install instructions for `neil` is given only for Mac using the brew tool.
It took me a while to figure out how to install `neil` on Windows on Linux. From the getting started and usability perspective, simple, complete getting started instructions that work everywhere would be more helpful.
Previous info on how to use `deps-new` is hidden, not sure if it's intentional or if it's not a supported way anymore.
Please update the getting started info by either providing simple `neil` (and its dependencies) install information, and/or bring back the old `deps-new` instructions if still supported.
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the project homepage and README getting-started sections, beginning with the existing neil installation instructions and the hidden deps-new information. Confirm supported installation paths for Windows and Linux and whether deps-new remains supported; done means the getting-started documentation covers users beyond macOS and clearly explains the available options.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100