Added new README file.

README

-DUNE-ALUGrid module
-===================
-
-License
--------
-
-The DUNE-ALUGrid module is licensed under the GNU General
-Public License (GPL) version 2. The full license text can be found 
-in the file COPYING and via http://www.gnu.org/licenses/gpl.html .
-
-
-Compiler 
---------
-
-The DUNE-ALUGrid code is known to compile with the GNU Compiler version 4.6.x or higher. 
-The code also compiles with the INTEL C++ Compiler (tested version 13.1).
-
-The compiler can be chosen by setting the variable CXX correctly, i.e. 
-CXX=g++ or CXX=icpc. Please see the documentation of the DUNE build system.
-
-
-Dynamic Load Balancing Options
-------------------------------
-
-If the compiled code is used for parallel computations including dynamic
-load balancing, then a parameter file named "alugrid.cfg" should be
-available in the directory the program is launched. See
-"misc/alugrid.cfg" for an example file. 
-
-The file must contain three values: 
-first row:  ldb_under (value < 1.0),  default value is 0.0
-second row: ldb_over (value > 1.0),   default value is 1.2 
-third row: Graph partitioning method, default method is 4 (METIS_PartGraphKway)
-
-Available methods are: 
-
-NONE = 0
-COLLECT = 1 (collect all elements to process 0)
-
-ALUGRID_SpaceFillingCurveLinkage       = 4
-ALUGRID_SpaceFillingCurveSerialLinkage = 5
-
-ALUGRID_SpaceFillingCurve       = 9  (default)
-ALUGRID_SpaceFillingCurveSerial = 10
-
-METIS_PartGraphKway        = 11
-METIS_PartGraphRecursive   = 12
-
-ZOLTAN_LB_HSFC  = 13
-ZOLTAN_LB_GRAPH = 14
-ZOLTAN_PARMETIS = 15
-
-See the documentation of the corresponding package for detail on the
-methods. 
-
-
-Debug Options
---------------
-
-There are several debug options that can be set an shell environment
-variable and that forces the code to produce debug output. To use this
-feature, the code must be compiled without the CPP variable NDEBUG set. 
-The following shell environment variables can be set to a level of 
-verbosity (higher is better).
-
-VERBOSE      general verbose output  
-VERBOSE_MGB  output produced by the macro grid builder 
-VERBOSE_LDB  output produced while partitioning. 
-VERBOSE_PLL  output produced by parallel grid methods
-
-
-Optimization 
--------------
-
-The DUNE-ALUGrid code is highly riddled with assert statements. 
-Therefore it is recommended to compile the library and the application code
-with the CPP variable NDEBUG set (i.e. -DNDEBUG) to avoid all asserts
-statement tests. 
-
-
-Debug
------
-
-For debugging the code the preprocessor variable NDEBUG must not be defined
-and additionally the preprocessor variable DEBUG_ALUGRID can be defined
-for object reference counting. In the read method of the message
-buffer for parallel computations a eof check is done on every read
-which can be disabled by passing the preprocessor variable
-NO_OBJECTSTREAM_DEBUG.
-
-
-Knowns Bugs 
------------
-
-- Ghost elements do not work for tetrahedral grid when using bisection refinement.

README.md

+DUNE-ALUGrid
+============
+
+[DUNE-ALUGrid][0] is a [Distributed and Unified Numerics Environment][1]
+module which implements the DUNE grid interface
+providing unstructured simplicial and cube grids.
+
+A detailed description of all the new features and some more
+details concerning the inner workings of DUNE-ALUGrid can be found
+in the paper The DUNE-ALUGrid Module. http://arxiv.org/abs/1407.6954.
+
+This is the paper we would ask everyone to cite when using DUNE-ALUGrid.
+
+Download via git:
+git clone https://gitlab.dune-project.org/extensions/dune-alugrid.git
+
+New features and improvements include
+
+  *  Conforming refinement for the 3D simplex grid
+  *  Parallel 2D grids
+  *  Internal load balancing based on space filling curves
+     making DUNE-ALUGrid self contained also in parallel
+  *  Bindings for fully parallel partitioners using [Zoltan][3]
+  *  Complete user control of the load balancing
+  *  Improved memory footprint
+
+The old ALUGrid version is deprecated and not supported anymore.
+We have removed the special grid types e.g. ALUConformGrid, ALUSimplexGrid, and ALUCubeGrid.
+Instead the type of the grid is always of the form
+Dune::ALUGrid< dimgrid, dimworld, eltype, refinetype, communicator > (where communicator has a default value). The values for eltype are cube,simplex and for refinetype the values are conforming, nonconforming defined in the DUNE namespace.
+The GRIDTYPE defines can still be used as before.
+
+The define HAVE_ALUGRID will not work correctly anymore. Since DUNE-ALUGrid is now
+a dune module the correct name for the define is HAVE_DUNE_ALUGRID.
+
+License
+-------
+
+The DUNE-ALUGrid library, headers and test programs are free open-source software,
+licensed under version 2 or later of the GNU General Public License.
+
+See the file [LICENSE][4] for full copying permissions.
+
+Installation
+------------
+
+For installation instructions please see the [DUNE website][2].
+
+Links
+-----
+
+ [0]: http://www.dune-project.org/extensions/dune-alugrid
+ [1]: http://www.dune-project.org
+ [2]: http://www.dune-project.org/doc/installation-notes.html
+ [3]: http://www.cs.sandia.gov/Zoltan/
+ [4]: LICENSE