update general doc

This commit is contained in:
Radovan Bast 2016-05-28 18:06:50 +02:00
parent 49d1652c98
commit 0f86f0bea9
2 changed files with 8 additions and 8 deletions

View File

@ -7,9 +7,10 @@ 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``. starting from a file called ``CMakeLists.txt``.
Autocmake composes CMake building blocks into a CMake project and generates Autocmake composes CMake building blocks into a CMake project and generates
``CMakeLists.txt`` as well as a setup script, which serves as a front-end to ``CMakeLists.txt`` as well as a setup script, 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.yml``
file:: file::
python update.py --self python update.py --self
@ -19,14 +20,14 @@ file::
| and updates the update.py script | | and updates the update.py script |
| | | |
v Developer maintaining v Developer maintaining
autocmake.cfg Autocmake autocmake.yml Autocmake
| | | |
| python update.py .. | | python update.py .. |
| | | |
v v v v
CMakeLists.txt (and setup front-end) CMakeLists.txt (and setup front-end)
| | | |
| python setup | | python setup or ./setup |
| which invokes CMake | | which invokes CMake |
v User of the code v User of the code
Makefile (or something else) | Makefile (or something else) |
@ -37,7 +38,7 @@ file::
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 is 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
it diverge while maintaining the CMake infrastructure in a growing number of it diverge while maintaining the CMake infrastructure in a growing number of
scientific projects which typically have very similar requirements: scientific projects which typically have very similar requirements:

View File

@ -3,9 +3,8 @@
Requirements and dependencies Requirements and dependencies
============================= =============================
Autocmake update and test scripts require Python 2.7 or higher. We try to also Autocmake update and test scripts require Python 2.7 or higher. We also
support Python 3 (tested with Python 3.4). If the script fails with Python 3, support Python 3 (we automatically test with 2.7 and 3.5).
consider this a bug and please file an issue.
The generated setup script runs with Python >= 2.6 (also tested with Python The generated setup script runs with Python >= 2.6 (also tested with Python
3.4; probably also lower). 3.5).