From 0f86f0bea968dab4f37ec62f0aa73086d1b22548 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Sat, 28 May 2016 18:06:50 +0200 Subject: [PATCH] update general doc --- doc/general/about.rst | 9 +++++---- doc/general/requirements.rst | 7 +++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/general/about.rst b/doc/general/about.rst index 95f141c..ea6cb11 100644 --- a/doc/general/about.rst +++ b/doc/general/about.rst @@ -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. Today, CMake is one of the trendier alternatives which can generate Makefiles starting from a file called ``CMakeLists.txt``. + 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``. All this is done based on a lightweight ``autocmake.cfg`` +``CMakeLists.txt``. All this is done based on a lightweight ``autocmake.yml`` file:: python update.py --self @@ -19,14 +20,14 @@ file:: | and updates the update.py script | | | v Developer maintaining - autocmake.cfg Autocmake + autocmake.yml Autocmake | | | python update.py .. | | | v v CMakeLists.txt (and setup front-end) | | - | python setup | + | python setup or ./setup | | which invokes CMake | v User of the code Makefile (or something else) | @@ -37,7 +38,7 @@ file:: Build/install/test targets 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 it diverge while maintaining the CMake infrastructure in a growing number of scientific projects which typically have very similar requirements: diff --git a/doc/general/requirements.rst b/doc/general/requirements.rst index 6143cb4..6d27d85 100644 --- a/doc/general/requirements.rst +++ b/doc/general/requirements.rst @@ -3,9 +3,8 @@ Requirements and dependencies ============================= -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, -consider this a bug and please file an issue. +Autocmake update and test scripts require Python 2.7 or higher. We also +support Python 3 (we automatically test with 2.7 and 3.5). The generated setup script runs with Python >= 2.6 (also tested with Python -3.4; probably also lower). +3.5).