diff --git a/README b/README index 96e0ca470576a92b8eaa81226276535663a36bda..d8108b2f98ec3ab2c9824446a0a1a3a2aab8253e 100644 --- a/README +++ b/README @@ -3,76 +3,19 @@ # Copyright holders: Felix Albrecht # License: BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) -Preparing the Sources -========================= - -Additional to the software mentioned in README you'll need the -following programs installed on your system: - - automake >= 1.5 - - autoconf >= 2.50 - - 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! - -$Id$ - +dune-gdt is a DUNE (http://www.dune-project.org) module which provides a +generic discretization toolbox for grid-based numerical methods. It contains +building blocks - like local operators, local evaluations, local assemblers - +for discretization methods as well as generic interfaces for objects like +discrete function spaces and basefunction sets. Default implementations for +these objects are provided using several of the main DUNE discretization +modules, like dune-fem (http://dune.mathematik.uni-freiburg.de/) or +dune-fem-localfunctions +(http://users.dune-project.org/projects/dune-fem-localfunctions). + +New users may best try out this module by using the git supermodule +dune-gdt-demos (http://users.dune-project.org/projects/dune-gdt-demos). +Experienced DUNE users may go ahead. As usual, you will have to call autogen, +configure and make using dunecontrol +(see http://www.dune-project.org/doc/installation-notes.html), working +examples are located in 'examples/'...