mitchellh / mitchellh/zig-overlay
Make it more clear how to specify zig version
Open
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 548
- Forks
- 63
- PR merge metrics
- No merged PRs in 30d
Description
In the readme it's shown:
packages.<version>
When I tried doing the obvious step:
packages.0.13.0 -> fail
packages.<0.13.0> -> fail
I had to go and search in github for others, to find you are supposed to do:
packages."0.13.0"
For me who is newer to nix this was not obvious.
Can we make it more clear in the README.md:
packages."<version>" or something.
Thanks.
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
Update README.md where the package version syntax is shown. Clarify that the version must be quoted, using the reported 0.13.0 example, and confirm the resulting flake syntax is understandable to new Nix users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- zig
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100