From c445f3868a6160d2e2f1c76083b6707112e57c01 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Sun, 28 Jun 2020 14:25:10 +0800 Subject: [PATCH] merge READMEs --- README.md | 32 ++++++++++++++++++++++++++++++++ wfvm/README.md | 26 -------------------------- 2 files changed, 32 insertions(+), 26 deletions(-) delete mode 100644 wfvm/README.md diff --git a/README.md b/README.md index 84a76d7..4a94d2f 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,35 @@ Example applications: * Creating reproducible Windows VM images with pre-installed software. * Compiling Conda packages with Visual Studio in a fully reproducible manner and without having to deal with the constant data corruption caused by Conda. * Running Windows unit tests on Hydra. + + +How to use +========== + +Install a Windows image +----------------------- + +1. Adjust demo-image.nix accordingly +2. Run: + +If in impure mode +```shell +nix-build demo-image.nix +./result +``` +Results in a file called c.img + +If in pure mode +```shell +nix-build demo-image.nix +ls -la ./result +``` +Results in a symlink to the image in the nix store + + +Impure/pure mode +---------------- + +Sometimes it can be useful to build the image _outside_ of the Nix sandbox for debugging purposes. + +For this purpose we have an attribute called `impureMode` which outputs the shell script used by Nix inside the sandbox to build the image. diff --git a/wfvm/README.md b/wfvm/README.md deleted file mode 100644 index 5914229..0000000 --- a/wfvm/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Preparation steps - -## Install a Windows image - -1. Adjust demo-image.nix accordingly -2. Run: - -If in impure mode -```shell -nix-build demo-image.nix -./result -``` -Results in a file called c.img - -If in pure mode -```shell -nix-build demo-image.nix -ls -la ./result -``` -Results in a symlink to the image in the nix store - - -# Impure/pure mode -Sometimes it can be useful to build the image _outside_ of the Nix sandbox for debugging purposes. - -For this purpose we have an attribute called `impureMode` which outputs the shell script used by Nix inside the sandbox to build the image.