summary refs log tree commit diff
path: root/nixos/doc
diff options
context:
space:
mode:
authorRob Vermaas <rob.vermaas@gmail.com>2014-07-23 09:48:09 +0200
committerRob Vermaas <rob.vermaas@gmail.com>2014-07-23 09:48:09 +0200
commit4cac67cadaccad2807613463c65d8948b575575f (patch)
tree92e8306680d50a3d906e483b769eccd41c49769c /nixos/doc
parent6ca53139228bf55798e00be2532d9c80d7315499 (diff)
parentc59dc1ddc08c7f0fef10f55127b08a3fd86b9746 (diff)
downloadnixlib-4cac67cadaccad2807613463c65d8948b575575f.tar
nixlib-4cac67cadaccad2807613463c65d8948b575575f.tar.gz
nixlib-4cac67cadaccad2807613463c65d8948b575575f.tar.bz2
nixlib-4cac67cadaccad2807613463c65d8948b575575f.tar.lz
nixlib-4cac67cadaccad2807613463c65d8948b575575f.tar.xz
nixlib-4cac67cadaccad2807613463c65d8948b575575f.tar.zst
nixlib-4cac67cadaccad2807613463c65d8948b575575f.zip
Merge pull request #3335 from DamienCassou/doc-for-building-the-nixos-manual
README for building the nixos manual
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/nixos/doc/manual/README b/nixos/doc/manual/README
new file mode 100644
index 000000000000..84ee3125983d
--- /dev/null
+++ b/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 were the
+manual got generated.
\ No newline at end of file