coq-community / coq-nix-toolbox

Nix helper scripts to automate local builds and CI [maintainers=@CohenCyril,@Zimmi48]
MIT License
32 stars 10 forks source link

`.nix/config.yml` should be `.nix/config.nix` in README #79

Closed quinn-dougherty closed 2 years ago

quinn-dougherty commented 2 years ago
$ nix --version
nix (Nix) 2.3.15

README.md#Standalone states

nix-shell https://coq.inria.fr/nix/toolbox --arg do-nothing true --run generateNixDefault
nix-shell --arg do-nothing true --run "initNixConfig YOURPACKAGENAME"

This will create an initial .nix/config.yml that you should now manually edit. This file contains comments explaining each available option.

When I followed instructions,

$ ls .nix
config.nix  coq-nix-toolbox.nix

I did the cachix step too btw.

Really excited about this project, thanks for doing it!

Zimmi48 commented 2 years ago

Thanks for your report @quinn-dougherty!

That's a typo in the README. The expected extension of the file is .nix. That's the file you should manually edit.

Let us know if you encounter any other problem / difficulty to set things up.