Work on readmes

Author: scheibel

ADAPT

@@ -0,0 +1,91 @@
+
+To adapt this template to your own project, follow these steps:
+
+
+In the root directory adapt/change/do the following:
+--------------------------------------------------------------------
+
+* [ ] Edit AUTHORS
+* [ ] Edit LICENSE
+* [ ] Edit README.md
+* [ ] Rename ./template-config.cmake -> <project>-config.cmake
+
+CMakeLists.txt:
+* [ ]  Set META_PROJECT_*
+* [ ]  Set META_VERSION_*
+* [ ]  Set META_AUTHOR_*
+* [ ]  Set META_CMAKE_INIT_SHA (to the commit hash of the applied cmake-init template, e.g., to 83d7cbc29a6fcb74a98498e5b0fcebd953d9d5cc)
+* [ ]  Adjust INSTALL_* to the desired install locations for all systems (defaults should be fine for a start)
+
+
+In subdirectory "./deploy/" do:
+--------------------------------------------------------------------
+
+deploy/CMakeLists.txt:
+* [ ] Substitute pack-template.cmake -> pack-<project>.cmake
+* [ ] Exchange deploy/images/logo.ico
+* [ ] Exchange deploy/images/logo.bmp
+* [ ] Exchange deploy/images/logo.png
+* [ ] Rename deploy/packages/pack-template.cmake -> pack-<project>.cmake
+
+deploy/packages/pack-<project>.cmake:
+* [ ] Adjust OPTION_PACK_GENERATOR to your liking for all systems
+* [ ] Adjust package options, e.g., CPACK_DEBIAN_PACKAGE_DEPENDS, CPACK_DEBIAN_PACKAGE_SECTION, CPACK_DEBIAN_PACKAGE_PRIORITY, CPACK_RPM_PACKAGE_LICENSE, CPACK_RPM_PACKAGE_GROUP, ...
+
+In subdirectory "./source/" do:
+--------------------------------------------------------------------
+
+* [ ] Rename template-version.h -> <project>-version.h
+
+
+In subdirectory "./source/examples/fibcmd" do:
+--------------------------------------------------------------------
+
+source/fibcmd/main.cpp:
+* [ ] Substitute template-version.h -> <project>-version.h
+* [ ] Substitute TEMPLATE_VERSION -> <PROJECT>_VERSION
+
+
+In subdirectory "./source/codegeneration/" do:
+--------------------------------------------------------------------
+
+* [ ] Remove/replace *_features.h for project-specific compiler feature detection headers (generate with current CMake and place here old cmake compatibility)
+
+
+In subdirectory "./docs/api-docs/" do:
+--------------------------------------------------------------------
+
+docs/api-docs/doxyfile.in:
+* [ ] Adjust INPUT tag (list of doxygen annotated sources)
+
+docs/api-docs/CMakeLists.txt
+* [ ] Adjust DEPENDS parameter to include all targets of project
+
+
+In subdirectory "./docs/manual/" do:
+--------------------------------------------------------------------
+
+docs/manual/cmake-init.tex:
+* [ ] Rename to match own project name
+
+docs/manual/CMakeLists.txt
+* [ ] Adjust source and pdf file name
+
+
+In subdirectory "./source/tests/" do:
+--------------------------------------------------------------------
+
+source/tests/CMakeLists.txt:
+* [ ]  Set META_PROJECT_NAME
+
+
+General stuff left to do:
+--------------------------------------------------------------------
+
+* [ ] Rename and adjust targets in source/
+* [ ] Add new targets to source/CMakeLists.txt
+* [ ] Add new targets to ./{project}-config.cmake
+* [ ] Add new targets to the INPUT tag in docs/api-docs/doxyfile.in
+* [ ] Remove data/DATA_FOLDER.txt
+* [ ] Populate data/
+* [ ] Remove ADAPT.md

ADAPT.md

@@ -23,7 +23,7 @@ The cmake-init template assumes you want to setup a project using
 * C/C++ compiler
 
 
-# Resources
+# Contents
 
 * [Adaption Guide](#adaption-guide)
 * [Non-Goals](#non-goals)
@@ -48,22 +48,25 @@ The cmake-init template assumes you want to setup a project using
 
 # Adaption Guide
 
+The file [ADAPT.md](https://github.com/cginternals/cmake-init/blob/master/ADAPT.md) contains a task checklist for new projects.
+More generally, a new project should contain all core modules and, as needed, add the maintainer and development modules as required. cmake-init does not impose modularity rules for the cmake targets.
+
 # Non-Goals
 
 In order to be usable in a deterministic, idiomatic fashion, we avoid the following approaches and features:
 
-## Super-Build
+### Super-Build
 
 Due to the current semantics of targets and CMake internals, combining multiple
 cmake-init projects into one super-build project is not officially supported.
 There are limited and restricting workarounds.
 Actual solution: treat each project separately and use explicit dependency management.
 
-## High Abstraction
+### High Abstraction
 
 We use low abstractions to not build a language upon CMake a user has to learn.
 
-## File Glob
+### File Glob
 
 Explicit source specification prevents erroneous cases when adding and removing
 sources from the project tree.