diff --git a/.gitignore b/.gitignore index b745553..cd4ace3 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -saturn/system.nix +saturn/system.nix \ No newline at end of file diff --git a/README.md b/README.md index df74921..4123a9d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,18 @@ this is the basis of the saturnOS operating system ( sorry guix enjoyers ) to check for syntax errors, run `nix repl replEval.nix` and once inside the repl, run `imported` to check for syntax errors - -add the nixos channel 22.11 +## Setup +add the nixos channel 22.11 `nix-build '' -A config.system.build.isoImage -I nixos-config=default.nix` + +## Building and Running +### VM +To build the VM: + `nix run github:nix-community/nixos-generators -- -c default.nix -f vm -o result/vm` +This will build the VM, and register the result in the `result/vm` symlink. + +To run the VM, use `sudo result/vm/bin/run-qemu-vm`. (sudo can probably be avoided if you are in the KVM group... I think. TODO Lambda look this up) + +You can combine the two steps with the following: `sudo $(nix run github:nix-community/nixos-generators -- -c default.nix -f vm -o result/vm)` + +Or to build and run without registering a link (Good if you want a throw away VM which can be garbage collected): `sudo $(nix run github:nix-community/nixos-generators -- -c default.nix -f vm)`