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

extend doc

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

40
doc/developers/new-project.rst
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