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

refine doc

Browse Source
This commit is contained in:
Radovan Bast 2015-06-01 18:19:30 +02:00
parent ede53a5803
commit 9dac73a7ae
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/about.rst
View File

@ -3,14 +3,16 @@
About Autocmake About Autocmake
=============== ===============
CMake typically generates Makefiles based on CMakeLists.txt files. Autocmake CMake typically generates Makefiles based on CMakeLists.txt files. Autocmake
generates and assembles CMake files based on lightweight cfg-files. 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 CMake cons
---------- ----------
- Complexity - More complexity (not because CMake is complex but because of another layer)
- Yet another thing to learn: requires learning and training - Yet another thing to learn: requires learning and training
- Typically many files instead of one file - Typically many files instead of one file
- Documentation ("Which file do I need to edit to achieve X?") - 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 - MPI, OMP, CUDA
- Math libraries - Math libraries
- Make it easy for people who know CMake well to create well defined configurations - 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 - Philosophy
- Explicit is better than implicit - Explicit is better than implicit
- Convention over configuration - Convention over configuration