From 9e26e21f8728dea81c8dbf23bddfaccd6a76e0ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Sun, 14 May 2023 15:34:09 +0200 Subject: [PATCH] move out developer guide out of reference --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ docs/reference.md | 14 -------------- 2 files changed, 23 insertions(+), 14 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3aeefa7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +To run `nixos-anywhere` from the repo: + +```console +nix run . -- --help +``` + +To format the code: + +```console +nix fmt +``` + +To run all tests: + +```console +nix flake check -vL +``` + +To run an individual test: + +``` +nix build .#checks.x86_64-linux.from-nixos -vL +``` diff --git a/docs/reference.md b/docs/reference.md index d521ede..0976695 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -49,20 +49,6 @@ Options: build the closure on the remote machine instead of locally and copy-closuring it ``` -## Developer guide - -To run `nixos-anywhere` from the repo: - -```shell -nix run . -- --help -``` - -To format the code - -```shell -nix fmt -``` - ## Explanation of known error messages TODO: List actual error messages and meanings. Include: