summary refs log tree commit diff
diff options
context:
space:
mode:
authorRobert Hensing <robert@roberthensing.nl>2021-03-04 17:52:32 +0100
committerRobert Hensing <robert@roberthensing.nl>2021-03-04 18:10:39 +0100
commit0a4a486096bc2a6efb1bc0d11543f208eda23dc3 (patch)
tree5a86539441a12927edf0f0717502caa42bb88985
parent16b327c0b4eb3fed619960d6b9542a5204041cc2 (diff)
downloadnixpkgs-0a4a486096bc2a6efb1bc0d11543f208eda23dc3.tar
nixpkgs-0a4a486096bc2a6efb1bc0d11543f208eda23dc3.tar.gz
nixpkgs-0a4a486096bc2a6efb1bc0d11543f208eda23dc3.tar.bz2
nixpkgs-0a4a486096bc2a6efb1bc0d11543f208eda23dc3.tar.lz
nixpkgs-0a4a486096bc2a6efb1bc0d11543f208eda23dc3.tar.xz
nixpkgs-0a4a486096bc2a6efb1bc0d11543f208eda23dc3.tar.zst
nixpkgs-0a4a486096bc2a6efb1bc0d11543f208eda23dc3.zip
doc/README.md: init
-rw-r--r--doc/Makefile2
-rw-r--r--doc/README.md8
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 4f520779f5b..7affbb0bb51 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,4 +1,4 @@
-MD_TARGETS=$(addsuffix .xml, $(basename $(shell find . -type f -regex '.*\.md$$')))
+MD_TARGETS=$(addsuffix .xml, $(basename $(shell find . -type f -regex '.*\.md$$' -not -name README.md)))
 
 .PHONY: all
 all: validate format out/html/index.html out/epub/manual.epub
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 00000000000..cb52608bde5
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,8 @@
+
+# Nixpkgs/doc
+
+This directory houses the sources files for the Nixpkgs manual.
+
+You can find the [rendered documentation for Nixpkgs `unstable` on nixos.org](https://nixos.org/manual/nixpkgs/unstable/).
+
+If you want to contribute to the documentation, [here's how to do it](https://nixos.org/manual/nixpkgs/unstable/#chap-contributing).