summaryrefslogtreecommitdiffstats
path: root/Help/dev
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-02-23 19:05:38 (GMT)
committerBrad King <brad.king@kitware.com>2017-03-01 21:05:55 (GMT)
commitd33de80c8a9e3e5e56012cbfe640004f7cb1550f (patch)
tree5936e86b758caf8a41b049626c272f23710ac532 /Help/dev
parentebc28c156ee56c878990c53cbd62779249b139bb (diff)
downloadCMake-d33de80c8a9e3e5e56012cbfe640004f7cb1550f.zip
CMake-d33de80c8a9e3e5e56012cbfe640004f7cb1550f.tar.gz
CMake-d33de80c8a9e3e5e56012cbfe640004f7cb1550f.tar.bz2
Help/dev: Exclude this directory from user-facing documentation
Teach Sphinx and our own install rules to skip a `Help/dev` directory. This will give us a place to put developer-only documentation that should not be included in the user-facing documentation. Add a placeholder README.
Diffstat (limited to 'Help/dev')
-rw-r--r--Help/dev/README.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/Help/dev/README.rst b/Help/dev/README.rst
new file mode 100644
index 0000000..a7cafcc
--- /dev/null
+++ b/Help/dev/README.rst
@@ -0,0 +1,15 @@
+CMake Development
+*****************
+
+This directory contains documentation about development of CMake itself.
+It is not part of the user documentation distributed with CMake.
+
+Contributor Instructions
+========================
+
+See `CONTRIBUTING.rst`_ for instructions to contribute changes.
+
+The process for contributing changes is the same whether or not one
+has been invited to participate directly in upstream development.
+
+.. _`CONTRIBUTING.rst`: ../../CONTRIBUTING.rst