From 0b0f0ec691e5d92d7ff372087f3471ddf25ad6f3 Mon Sep 17 00:00:00 2001 From: Jonathan Youett <youett@math.fu-berlin.de> Date: Fri, 11 Nov 2016 10:52:42 +0100 Subject: [PATCH] Rewrite readme and use markdown format --- README | 71 ------------------------------------------------------- README.md | 25 ++++++++++++++++++++ 2 files changed, 25 insertions(+), 71 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index bde12c4..0000000 --- a/README +++ /dev/null @@ -1,71 +0,0 @@ -Preparing the Sources -========================= - -Additional to the software mentioned in README you'll need the -following programs installed on your system: - - automake >= 1.9 - - autoconf >= 2.62 - - libtool - -Getting started ---------------- - -If these preliminaries are met, you should run - - dunecontrol all - -which will find all installed dune modules as well as all dune modules -(not installed) which sources reside in a subdirectory of the current -directory. Note that if dune is not installed properly you will either -have to add the directory where the dunecontrol script resides (probably -./dune-common/bin) to your path or specify the relative path of the script. - -On your project and all uninstalled DUNE source modules found the script -will then calls the GNU autoconf/automake to create a ./configure-script -and the Makefiles. Afterwards that configure script will be called and the -modules will be build using make all - -Most probably you'll have to provide additional information to dunecontrol -(e. g. compilers, configure options) and/or make options. - -The most convenient way is to use options files in this case. The files -defining three variables: - -AUTOGEN_FLAGS flags passed to autogen -CONFIGURE_FLAGS flags passed to configure -MAKE_FLAGS flags passed to make - -An example options file might look like this: - -#use this options to autogen, configure and make if no other options are given -AUTOGEN_FLAGS="--ac=2.50 --ac=1.8" #Forces automake 2,50 and autoconf 1.8 -CONFIGURE_FLAGS="CXX=g++-3.4 --prefix=/install/path" #force g++-3.4 as compiler -MAKE_FLAGS=install #Per default run make install instead of simply make - -If you save this information into example.opts you can path the opts file to -dunecontrol via the --opts option, e. g. - - dunecontrol --opts=example.opts all - -To get a full list of available configure flags just run - - dunecontrol configure --help - -after running at least - dunecontrol autogen - -More info ---------- - -See - - dunecontrol --help - -for further options. - - -The full build-system is described in the dune-common/doc/buildsystem (SVN version) or under share/doc/dune-common/buildsystem if you installed DUNE! - diff --git a/README.md b/README.md new file mode 100644 index 0000000..f5e16fc --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +DUNE-library +============ + +DUNE, the Distributed and Unified Numerics Environment is a modular toolbox +for solving partial differential equations with grid-based methods. + +The main intention is to create slim interfaces allowing an efficient use of +legacy and/or new libraries. Using C++ techniques DUNE allows to use very +different implementation of the same concept (i.e. grid, solver, ...) under +a common interface with a very low overhead. + +DUNE was designed with flexibility in mind. It supports easy discretization +using methods, like Finite Elements, Finite Volume and also Finite +Differences. + +dune-matrix-vector +------------------- +This module provides static algebra tools for matrices and vectors +of the dune-common and dune-istl modules. + +More information +---------------- + +Check dune-common for more details concerning dependencies, known bugs, + license and installation. -- GitLab