introduce FAQ section; fixes #8

dev-cafe · Jun 23, 2015 · feafd11 · feafd11
1 parent da00829
commit feafd11
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/doc/autocmake-users-faq.rst b/doc/autocmake-users-faq.rst
@@ -0,0 +1,14 @@
+
+
+FAQ
+===
+
+
+Should I include and track also files generated by Autocmake in my repository?
+------------------------------------------------------------------------------
+
+Yes, you probably want to do that. Autocmake generates a number of files which
+in principle could be generated at configure- or build-time.  However, you
+probably do not want the users of your code to run any Autocmake scripts like
+``update.py`` to generate the files they need to build the project. They will
+run ``setup.py`` directly and expect everything to just work (TM).
diff --git a/doc/index.rst b/doc/index.rst
@@ -19,6 +19,7 @@ For developers who use Autocmake
 .. toctree::
    :maxdepth: 2
 
+   autocmake-users-faq.rst
    new-project.rst
    customizing-modules.rst
    updating-modules.rst