Unclear documentation
elmarsto opened this issue · comments
Describe the bug
The sample nix code in the README.md is without context. Is this a default.nix? Is this a shell.nix? Is this to be pasted into one's configuration.nix? I've been using Nix for almost a year now, but I still had to dig through the Issues here to find a complete (albeit breaking) example of how one might use this in situ to create a default.nix for an arbitrary Go project on github. (Thank you #18)
To Reproduce
Be new to Nix and attempt to understand what it is one is looking at here :)
Expected behavior
A clear and concise description of what this is, how it works, why it's necessary, and compare/contrast with other build tooling the user might already know. E.g. https://github.com/DavHau/nix-pypi-fetcher is the only other not-included-by-default build tool I've used; other people will come to this with other context; help ease us in to your paradigm. Work with us here :)
Environment
NixOS 21.05 + a bunch of unstable packages
- Version of the code:67f22dd738d092c6ba88e420350ada0ed4992ae8
Additional context
Thank you nonetheless for this fantastic contribution to Nix and NixOS.