diff --git a/doc/about.rst b/doc/about.rst index 5e039de..23617da 100644 --- a/doc/about.rst +++ b/doc/about.rst @@ -3,14 +3,16 @@ About Autocmake =============== -CMake typically generates Makefiles based on CMakeLists.txt files. Autocmake -generates and assembles CMake files based on lightweight cfg-files. +CMake typically generates Makefiles based on CMakeLists.txt files. Autocmake +assembles CMake modules, generates ``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`` file. CMake cons ---------- -- Complexity +- More complexity (not because CMake is complex but because of another layer) - Yet another thing to learn: requires learning and training - Typically many files instead of one file - Documentation ("Which file do I need to edit to achieve X?") @@ -34,7 +36,7 @@ Motivation to create a CMake framework library - MPI, OMP, CUDA - Math libraries - Make it easy for people who know CMake well to create well defined configurations -- Make it easy for people who do not know CMake to get started in minutes +- Make it easy for people who do not know CMake to generate a CMake infrastructure within minutes - Philosophy - Explicit is better than implicit - Convention over configuration