about summary refs log tree commit diff
path: root/nixpkgs/nixos/doc/manual/README
diff options
context:
space:
mode:
Diffstat (limited to 'nixpkgs/nixos/doc/manual/README')
-rw-r--r--nixpkgs/nixos/doc/manual/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/nixpkgs/nixos/doc/manual/README b/nixpkgs/nixos/doc/manual/README
new file mode 100644
index 000000000000..587f6275197a
--- /dev/null
+++ b/nixpkgs/nixos/doc/manual/README
@@ -0,0 +1,12 @@
+To build the manual, you need Nix installed on your system (no need
+for NixOS). To install Nix, follow the instructions at
+
+    https://nixos.org/nix/download.html
+
+When you have Nix on your system, in the root directory of the project
+(i.e., `nixpkgs`), run:
+
+    nix-build nixos/release.nix -A manual.x86_64-linux
+
+When this command successfully finishes, it will tell you where the
+manual got generated.