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

update general doc section

Browse Source
This commit is contained in:
Radovan Bast 2015-10-05 12:54:10 +02:00
parent a823e300f6
commit a8bc2b0a1f
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/general/about.rst
View File

@ -6,9 +6,8 @@ About Autocmake
Building libraries and executables from sources can be a complex task. Several Building libraries and executables from sources can be a complex task. Several
solutions exist to this problem: GNU Makefiles is the traditional approach. solutions exist to this problem: GNU Makefiles is the traditional approach.
Today, CMake is one of the trendier alternatives which can generate Makefiles Today, CMake is one of the trendier alternatives which can generate Makefiles
starting from a file called ``CMakeLists.txt``. Consider Autocmake a starting from a file called ``CMakeLists.txt``.
``CMakeLists.txt``-generator. Autocmake is a collection of scripts which Autocmake composes CMake building blocks into a CMake project and generates
compose well tested CMake building blocks into a CMake project and generates
``CMakeLists.txt`` as well as ``setup.py``, which serves as a front-end to ``CMakeLists.txt`` as well as ``setup.py``, which serves as a front-end to
``CMakeLists.txt``. All this is done based on a lightweight ``autocmake.cfg`` ``CMakeLists.txt``. All this is done based on a lightweight ``autocmake.cfg``
file:: file::
@ -17,6 +16,8 @@ file::
| | | |
| fetches Autocmake | | fetches Autocmake |
| infrastructure | | infrastructure |
| and updates the update.py script |
| |
v Developer maintaining v Developer maintaining
autocmake.cfg Autocmake autocmake.cfg Autocmake
| | | |
@ -35,7 +36,6 @@ file::
v v v v
Build/install/test targets Build/install/test targets
Our main motivation to create Autocmake as a CMake framework library and Our main motivation to create Autocmake as a CMake framework library and
CMake module composer was to simplify CMake code transfer between codes. We got CMake module composer was to simplify CMake code transfer between codes. We got
tired of manually diffing and copy-pasting boiler-plate CMake code and watching tired of manually diffing and copy-pasting boiler-plate CMake code and watching
@ -44,7 +44,7 @@ scientific projects which typically have very similar requirements:
- Fortran and/or C and/or C++ support - Fortran and/or C and/or C++ support
- Tuning of compiler flags - Tuning of compiler flags
- Front-end script for the CMake-unaware user (setup.py) - Front-end script with good defaults (setup.py)
- Support for parallelization: MPI, OMP, CUDA - Support for parallelization: MPI, OMP, CUDA
- Math libraries: BLAS, LAPACK - Math libraries: BLAS, LAPACK

4
doc/general/requirements.rst
View File

@ -7,8 +7,8 @@ Autocmake update and test scripts require Python 2.7 or higher. We try to also
support Python 3 (tested with Python 3.4). If the script fails with Python 3, support Python 3 (tested with Python 3.4). If the script fails with Python 3,
consider this a bug and please file an issue. consider this a bug and please file an issue.
The generated CMake infrastructure requires CMake >= 2.8. The generated The generated ``setup.py`` runs with Python >= 2.7 (also tested with Python
``setup.py`` runs with Python >= 2.7 (also tested with Python 3.4; probably also lower). 3.4; probably also lower).
.. todo:: .. todo::