From: Luca Heltai Date: Wed, 23 Jul 2014 17:31:54 +0000 (+0200) Subject: Switched README to md format. X-Git-Tag: v8.2.0-rc1~251^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F20%2Fhead;p=dealii.git Switched README to md format. Implemented Matthias' suggestions. --- diff --git a/README b/README deleted file mode 100644 index c88147149a..0000000000 --- a/README +++ /dev/null @@ -1,34 +0,0 @@ -What is deal.II? - - deal.II is a C++ program library targeted at the computational solution - of partial differential equations using adaptive finite elements. It uses - state-of-the-art programming techniques to offer you a modern interface - to the complex data structures and algorithms required. - -For the impatient: - - Configure compile and install the deal.II library with: - - $ mkdir build - $ cd build - $ cmake -DCMAKE_INSTALL_PREFIX=/path/where/deal.II/should/be/intalled/to .. - $ make install (alternatively $ make -j install) - $ make test - - A detailed ReadME can be found at ./doc/readme.html and - ./doc/users/cmake.html or at http://www.dealii.org/. - -Getting started: - - The tutorial steps are located under ./examples - Information about the tutorial steps can be found at - ./doc/doxygen/tutorial/index.html or at http://www.dealii.org/. - -License: - - Please see the file LICENSE for details - -Further information: - - For further information have a look at ./doc/index.html or at - http://www.dealii.org. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..1b29ac56f8 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +What is deal.II? +================ + +deal.II is a C++ program library targeted at the computational solution +of partial differential equations using adaptive finite elements. It uses +state-of-the-art programming techniques to offer you a modern interface +to the complex data structures and algorithms required. + +For the impatient: +------------------ + +Configure compile and install the deal.II library with: + + $ mkdir build + $ cd build + $ cmake -DCMAKE_INSTALL_PREFIX=/path/where/deal.II/should/be/intalled/to .. + $ make install (alternatively $ make -j install) + $ make test + +A detailed *ReadME* can be found at ./doc/readme.html and +./doc/users/cmake.html or at http://www.dealii.org/. + +Getting started: +---------------- + +The tutorial steps are located under ./examples/ +Information about the tutorial steps can be found at +./doc/doxygen/tutorial/index.html or at http://www.dealii.org/. + +License: +-------- + +Please see the file ./LICENSE for details + +Further information: +-------------------- + +For further information have a look at ./doc/index.html or at +http://www.dealii.org.