introduce FAQ section; fixes #8
This commit is contained in:
parent
da00829be5
commit
feafd11524
14
doc/autocmake-users-faq.rst
Normal file
14
doc/autocmake-users-faq.rst
Normal 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).
|
@ -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
|
||||
|
Loading…
x
Reference in New Issue
Block a user