Update to latest changes

.codedocs

@@ -0,0 +1,193 @@
+# CodeDocs.xyz Configuration File
+#
+# Rename this example to '.codedocs' and put it in the root directory of your
+# repository. This file is optional, documentation will still be generated
+# without it using sensible defaults.
+
+#---------------------------------------------------------------------------
+# CodeDocs Configuration
+#---------------------------------------------------------------------------
+
+# Include the Doxygen configuration from another file.
+# The file must be a relative path with respect to the root of the repository.
+# If any of the options in this doxyfile include a path (ie, INPUT), these
+# paths will be considered relative to the root of the repository, not the
+# location of the DOXYFILE.
+
+DOXYFILE = Doxyfile
+
+# Specify external repository to link documentation with.
+# This is similar to Doxygen's TAGFILES option, but will automatically link to
+# tags of other repositories already using CodeDocs. List each repository to
+# link with by giving its location in the form of owner/repository.
+# For example:
+#   TAGLINKS = doxygen/doxygen CodeDocs/osg
+# Note: these repositories must already be built on CodeDocs.
+
+TAGLINKS =
+
+#---------------------------------------------------------------------------
+# Doxygen Configuration
+#---------------------------------------------------------------------------
+
+# Doxygen configuration may also be placed in this file.
+# Currently, the following Doxygen configuration options are available. Refer
+# to http://doxygen.org/manual/config.html for detailed explanation of the
+# options. To request support for more options, contact support@codedocs.xyz.
+#
+# ABBREVIATE_BRIEF =
+# ALIASES =
+# ALLEXTERNALS =
+# ALLOW_UNICODE_NAMES =
+# ALPHABETICAL_INDEX =
+# ALWAYS_DETAILED_SEC =
+# AUTOLINK_SUPPORT =
+# BRIEF_MEMBER_DESC =
+# BUILTIN_STL_SUPPORT =
+# CALLER_GRAPH =
+# CALL_GRAPH =
+# CASE_SENSE_NAMES =
+# CITE_BIB_FILES =
+# CLASS_DIAGRAMS =
+# CLASS_GRAPH =
+# COLLABORATION_GRAPH =
+# COLS_IN_ALPHA_INDEX =
+# CPP_CLI_SUPPORT =
+# DIAFILE_DIRS =
+# DIRECTORY_GRAPH =
+# DISABLE_INDEX =
+# DISTRIBUTE_GROUP_DOC =
+# DOTFILE_DIRS =
+# DOT_FONTNAME =
+# DOT_FONTSIZE =
+# DOT_GRAPH_MAX_NODES =
+# DOT_IMAGE_FORMAT =
+# DOT_TRANSPARENT =
+# DOXYFILE_ENCODING =
+# ENABLED_SECTIONS =
+# ENABLE_PREPROCESSING =
+# ENUM_VALUES_PER_LINE =
+# EXAMPLE_PATH =
+# EXAMPLE_PATTERNS =
+# EXAMPLE_RECURSIVE =
+# EXCLUDE =
+# EXCLUDE_PATTERNS =
+# EXCLUDE_SYMBOLS =
+# EXPAND_AS_DEFINED =
+# EXPAND_ONLY_PREDEF =
+# EXTENSION_MAPPING =
+# EXTERNAL_GROUPS =
+# EXTERNAL_PAGES =
+# EXTRACT_ALL =
+# EXTRACT_ANON_NSPACES =
+# EXTRACT_LOCAL_CLASSES =
+# EXTRACT_LOCAL_METHODS =
+# EXTRACT_PACKAGE =
+# EXTRACT_PRIVATE =
+# EXTRACT_STATIC =
+# EXT_LINKS_IN_WINDOW =
+# FILE_PATTERNS =
+# FORCE_LOCAL_INCLUDES =
+# FORMULA_FONTSIZE =
+# FORMULA_TRANSPARENT =
+# FULL_PATH_NAMES =
+# GENERATE_BUGLIST =
+# GENERATE_DEPRECATEDLIST =
+# GENERATE_LEGEND =
+# GENERATE_TESTLIST =
+# GENERATE_TODOLIST =
+# GENERATE_TREEVIEW =
+# GRAPHICAL_HIERARCHY =
+# GROUP_GRAPHS =
+# GROUP_NESTED_COMPOUNDS =
+# HIDE_COMPOUND_REFERENCE= =
+# HIDE_FRIEND_COMPOUNDS =
+# HIDE_IN_BODY_DOCS =
+# HIDE_SCOPE_NAMES =
+# HIDE_UNDOC_CLASSES =
+# HIDE_UNDOC_MEMBERS =
+# HIDE_UNDOC_RELATIONS =
+# HTML_COLORSTYLE_GAMMA =
+# HTML_COLORSTYLE_HUE =
+# HTML_COLORSTYLE_SAT =
+# HTML_DYNAMIC_SECTIONS =
+# HTML_EXTRA_FILES =
+# HTML_EXTRA_STYLESHEET =
+# HTML_FOOTER =
+# HTML_HEADER =
+# HTML_INDEX_NUM_ENTRIES =
+# HTML_STYLESHEET =
+# HTML_TIMESTAMP =
+# IDL_PROPERTY_SUPPORT =
+# IGNORE_PREFIX =
+# IMAGE_PATH =
+# INCLUDED_BY_GRAPH =
+# INCLUDE_FILE_PATTERNS =
+# INCLUDE_GRAPH =
+# INCLUDE_PATH =
+# INHERIT_DOCS =
+# INLINE_GROUPED_CLASSES =
+# INLINE_INFO =
+# INLINE_INHERITED_MEMB =
+# INLINE_SIMPLE_STRUCTS =
+# INLINE_SOURCES =
+# INPUT =
+# INPUT_ENCODING =
+# INTERACTIVE_SVG =
+# INTERNAL_DOCS =
+# JAVADOC_AUTOBRIEF =
+# LAYOUT_FILE =
+# MACRO_EXPANSION =
+# MARKDOWN_SUPPORT =
+# MAX_DOT_GRAPH_DEPTH =
+# MSCFILE_DIRS =
+# MULTILINE_CPP_IS_BRIEF =
+# OPTIMIZE_FOR_FORTRAN =
+# OPTIMIZE_OUTPUT_FOR_C =
+# OPTIMIZE_OUTPUT_JAVA =
+# OPTIMIZE_OUTPUT_VHDL =
+# OUTPUT_LANGUAGE =
+# PLANTUML_JAR_PATH =
+# PREDEFINED =
+# PROJECT_BRIEF =
+# PROJECT_LOGO =
+# PROJECT_NAME =
+# PROJECT_NUMBER =
+# QT_AUTOBRIEF =
+# RECURSIVE =
+# REFERENCED_BY_RELATION =
+# REFERENCES_LINK_SOURCE =
+# REFERENCES_RELATION =
+# REPEAT_BRIEF =
+# SEARCHENGINE =
+# SEARCH_INCLUDES =
+# SEPARATE_MEMBER_PAGES =
+# SHORT_NAMES =
+# SHOW_FILES =
+# SHOW_GROUPED_MEMB_INC =
+# SHOW_INCLUDE_FILES =
+# SHOW_NAMESPACES =
+# SHOW_USED_FILES =
+# SIP_SUPPORT =
+# SKIP_FUNCTION_MACROS =
+# SORT_BRIEF_DOCS =
+# SORT_BY_SCOPE_NAME =
+# SORT_GROUP_NAMES =
+# SORT_MEMBERS_CTORS_1ST =
+# SORT_MEMBER_DOCS =
+# SOURCE_BROWSER =
+# SOURCE_TOOLTIPS =
+# STRICT_PROTO_MATCHING =
+# STRIP_CODE_COMMENTS =
+# STRIP_FROM_INC_PATH =
+# STRIP_FROM_PATH =
+# SUBGROUPING =
+# TAB_SIZE =
+# TEMPLATE_RELATIONS =
+# TREEVIEW_WIDTH =
+# TYPEDEF_HIDES_STRUCT =
+# UML_LIMIT_NUM_FIELDS =
+# UML_LOOK =
+# USE_MDFILE_AS_MAINPAGE =
+# VERBATIM_HEADERS =
+#

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "DACE 2.0 API Manual"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "ESA 4000117860/16/NL/LF/as"
+#PROJECT_NUMBER         = "ESA 4000117860/16/NL/LF/as"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -6,43 +6,32 @@ The Differential Algebra Computational Toolbox.
 ## Requirements
 To use the DACE library, you need a C++11 compatible C++ compiler. Almost all modern C++ compilers (GNU, Clang, MS Visual Studio) meet that requirement nowadays. We also highly recommend using CMake as a build system, and obviously Git as your source code management system.
 
-On Windows, you need to download Microsoft Visual Studio (the free Community Edition is fine). On MacOS X, you need to install the Xcode package from Apple from the App Store. On Linux, you can install the compiler toolchain through your package system if they don't already come pre-installed.
+On Linux, you can install the compiler toolchain through your package system if they don't already come pre-installed. On Windows it is suggested to use the WSL environment and follow the linux procedure, or download Microsoft Visual Studio (the free Community Edition is fine). On MacOS X, you need to install the Xcode package from Apple from the App Store. 
 
-To build Windows DACE library installer packages, you additionally need the NSIS installer compiler.
+To build Windows DACE library installer packages, you additionally need the NSIS installer compiler. (Deprecated, will be removed soon)
 
 ## Getting started
-To get started, either download one of the pre-built release packages for your platform (see the Releases tab above), or just clone the entire repository and build the library from scratch (which really is very easy).
-
-To use the DACE, we recommend using CMake. New DACE releases past version 2.0.1 come with a CMake package system plugin that allows very simple use of the DACE within the CMake framework. To get started, have a look at the Tutorials directories. Both of the Tutorials there are independent projects with their own stand-alone CMake file you can use as a starting point for your own programs.
+To get started just clone the entire repository and build the library from scratch (which really is very easy). You can use the current development version if you want the latests improvement and bug fixes or point to the Releases page for official released versions.
 
 ## Building the DACE
-To build your own version of the DACE library, simply clone this repository:
+To build the DACE library, simply clone this repository:
 ```
-git clone "https://github.com/dacelib/dace.git"
+git clone "https://github.com/dacelib/dace.git" dace
 ```
-Then create a build directory and run cmake, and then make to compile everything:
+Then create a build directory, run cmake, and then cmake --build to compile everything:
 ```
-cd dace
-mkdir build
-cd build
-cmake ..
-make
+mkdir dace-build
+cmake -S dace/ -B dace-build/
+cmake --build dace-build/
 ```
-After some compiling, you should have a sparkling new dace library ready for use. To install it directly into your system, you can just use:
+After some compiling, you should have a sparkling new dace library ready for use in the dace-build folder. 
+
+Optionally you can install the freshly built DACE library directly into your system:
 ```
-sudo make install
+sudo cmake --install dace-build/
 ```
 The ```sudo``` is there to give you the required permissions to install into your system directories (usually ```/usr/local```).
 
-## Running the Tutorials
-To test if your installation was successful, you can try to build one of the Tutorials:
-```
-cd ../Tutorials/Tutorial1
-mkdir build
-cd build
-cmake ..
-make
-```
-This should automatically compile all tutorials, ready to be run by you using e.g. the command ```./Example1```.
+We have moved the tutorials to a different repository https://github.com/dacelib/dace-tutorials to keep the main repository clean. You can clone the tutorials repository and follow the instructions there to get started with DACE.
 
-Also have a look at the [DACE Wiki pages](https://github.com/dacelib/dace/wiki) if you have further questions
+Also have a look at the [DACE Wiki pages](https://github.com/dacelib/dace/wiki) if you have further questions.