AnotherFoxGuy/autocmake
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

introduce FAQ section; fixes #8

Browse Source
This commit is contained in:
Radovan Bast 2015-06-23 09:40:27 +02:00
parent da00829be5
commit feafd11524
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/autocmake-users-faq.rst Normal file
View File

@ -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).

1
doc/index.rst
View File

@ -19,6 +19,7 @@ For developers who use Autocmake
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
autocmake-users-faq.rst
new-project.rst new-project.rst
customizing-modules.rst customizing-modules.rst
updating-modules.rst updating-modules.rst