From feafd115247fa83324fb0f69986d7c26e05664d0 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Tue, 23 Jun 2015 09:40:27 +0200 Subject: [PATCH] introduce FAQ section; fixes #8 --- doc/autocmake-users-faq.rst | 14 ++++++++++++++ doc/index.rst | 1 + 2 files changed, 15 insertions(+) create mode 100644 doc/autocmake-users-faq.rst diff --git a/doc/autocmake-users-faq.rst b/doc/autocmake-users-faq.rst new file mode 100644 index 0000000..b52ef56 --- /dev/null +++ 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 index 506b7c5..09f0ebe 100644 --- 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