69 lines
1.8 KiB
ReStructuredText
69 lines
1.8 KiB
ReStructuredText
|
|
|
|
Bootstrapping a new project
|
|
===========================
|
|
|
|
|
|
Bootstrapping Autocmake
|
|
-----------------------
|
|
|
|
Download the ``update.py`` and execute it with ``--self`` to fetch other
|
|
infrastructure files which will be needed to build the project::
|
|
|
|
$ 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
|
|
|
|
On the MS Windows system, you can use the PowerShell wget-replacement::
|
|
|
|
$ Invoke-WebRequest https://github.com/scisoft/autocmake/raw/master/update.py -OutFile update.py
|
|
|
|
This creates (or updates) the following files (an existing ``autocmake.cfg`` is
|
|
not overwritten by the script)::
|
|
|
|
cmake/
|
|
autocmake.cfg # edit this file
|
|
update.py # no need to edit
|
|
lib/
|
|
config.py # no need to edit
|
|
docopt/
|
|
docopt.py # no need to edit
|
|
|
|
Note that all other listed files are overwritten (use version control).
|
|
|
|
|
|
Generating the CMake infrastructure
|
|
-----------------------------------
|
|
|
|
Now customize ``autocmake.cfg`` to your needs
|
|
(see :ref:`autocmake_cfg`)
|
|
and then run the ``update.py`` script which
|
|
creates ``CMakeLists.txt`` and a setup script in the target path::
|
|
|
|
$ python update.py ..
|
|
|
|
The script also downloads external CMake modules specified in ``autocmake.cfg`` to a directory
|
|
called ``downloaded/``::
|
|
|
|
cmake/
|
|
autocmake.cfg # edit this file
|
|
update.py # no need to edit
|
|
lib/
|
|
config.py # no need to edit
|
|
docopt/
|
|
docopt.py # no need to edit
|
|
downloaded/ # contains CMake modules fetched from the web
|
|
|
|
|
|
Building the project
|
|
--------------------
|
|
|
|
Now you have ``CMakeLists.txt`` and setup script in the project root and the project
|
|
can be built::
|
|
|
|
$ cd ..
|
|
$ python setup [-h]
|
|
$ cd build
|
|
$ make
|