extend doc

This commit is contained in:
Radovan Bast
2015-07-27 20:29:48 +02:00
parent d3910cd04d
commit 7c52934091
8 changed files with 52 additions and 28 deletions

View File

@ -0,0 +1,9 @@
.. _autocmake_cfg:
Configuring autocmake.cfg
=========================
.. todo::
Write me ...

View File

@ -21,9 +21,9 @@ Adapt local copies of CMake modules
-----------------------------------
A better solution is to download the CMake modules that you wish you customize
to a separate directory and source the customized CMake modules in
``autocmake.cfg``. Alternatively you can serve your custom
modules from your own http server.
to a separate directory (e.g. ``custom/``) and source the customized CMake
modules in ``autocmake.cfg``. Alternatively you can serve your custom modules
from your own http server.
Create own CMake modules

View File

@ -1,7 +1,7 @@
FAQ
===
FAQ for developers
==================
Should I include and track also files generated by Autocmake in my repository?

View File

@ -1,20 +1,20 @@
Building a new project
======================
Creating the configuration for a new project
============================================
Bootstrapping Autocmake
-----------------------
Download the ``update.py`` and execute it to fetch other infrastructure files
which will be needed to build the project (on Windows ``wget`` is probably
not available - in this case use an alternative)::
Download the ``update.py`` and execute it with ``--self`` to fetch other
infrastructure files which will be needed to build the project (on Windows
``wget`` is probably not available - in this case use an alternative)::
mkdir cmake # does not have to be called "cmake" - take the name you prefer
cd cmake
wget https://github.com/scisoft/autocmake/raw/master/update.py
python update.py --self
$ mkdir cmake # does not have to be called "cmake" - take the name you prefer
$ cd cmake
$ wget https://github.com/scisoft/autocmake/raw/master/update.py
$ python update.py --self
This creates (or updates) the following files (an existing ``autocmake.cfg`` is
not overwritten by the script)::
@ -32,12 +32,14 @@ Note that all other listed files are overwritten (use version control!).
Generating the CMake infrastructure
-----------------------------------
Edit ``autocmake.cfg`` and then run the ``update.py`` script which
creates ``CMakeLists.txt`` and ``setup.py`` in the build path::
Now customize ``autocmake.cfg`` to your needs
(see :ref:`autocmake_cfg`)
and then run the ``update.py`` script which
creates ``CMakeLists.txt`` and ``setup.py``::
python update.py ..
$ python update.py ..
The script also downloads remote CMake modules specified in ``autocmake.cfg`` to a directory
The script also downloads external CMake modules specified in ``autocmake.cfg`` to a directory
called ``downloaded/``::
cmake/
@ -52,10 +54,10 @@ called ``downloaded/``::
Building the project
--------------------
Now you have ``CMakeLists.txt`` and ``setup.py`` in the project root and you can build
the project::
Now you have ``CMakeLists.txt`` and ``setup.py`` in the project root and the project
can be built::
cd ..
python setup.py [-h]
cd build
make
$ cd ..
$ python setup.py [-h]
$ cd build
$ make

View File

@ -5,8 +5,8 @@ Updating CMake modules
To update CMake modules fetched from the web you need to run the ``update.py`` script::
cd cmake
python update.py ..
$ cd cmake
$ python update.py ..
The CMake modules are not fetched or updated at configure time or build time.
In other words, if you never re-run ``update.py`` script and never modify the