From: Matthias Maier Date: Wed, 25 Mar 2015 15:47:32 +0000 (+0100) Subject: Update various readme files to markdown X-Git-Tag: v8.3.0-rc1~355^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=18df980254926a71ecc134fe64009a7f76ba2bab;p=dealii.git Update various readme files to markdown --- diff --git a/README.md b/README.md index 3c5da8298e..386aa9b01b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ For the impatient: Let's say you've unpacked the .tar.gz file, or cloned the git repository into a directory /path/to/dealii/sources. Then configure, compile, and install the -deal.II library with: +deal.II library with: $ mkdir build $ cd build diff --git a/bundled/README.bundled b/bundled/README.md similarity index 54% rename from bundled/README.bundled rename to bundled/README.md index 81386edbeb..063d026e5f 100644 --- a/bundled/README.bundled +++ b/bundled/README.md @@ -1,64 +1,54 @@ This folder contains third party projects bundled with deal.II +============================================================== -PLEASE NOTE THAT THESE PROJECTS ARE COPYRIGHTED BY OTHERS THAN THE deal.II -AUTHORS, but are included by permission. For details, consult the stated -licenses below. +**Please note that these projects are copyrighted by others than the deal.II +authors, but are included by permission. For details, consult the stated +licenses below.** Below is a detailed list of the content of each subdirectory, and the licenses that apply. -./boost-1.49.0 -============ +boost-* +------- Contains parts of the boost c++ libraries copyrighted by the boost authors and licensed under the Boost Software License Version 1.0. See -boost-1.49.0/LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt +`boost-*/LICENSE_1_0.txt` or http://www.boost.org/LICENSE_1_0.txt A full version of the library can be downloaded at http://www.boost.org/. -./muparser_v2_2_3 -============== +muparser_* +---------- Contains the MuParser project licensed under the MIT license. A full version of the FunctionParser project can be downloaded at http://muparser.beltoforion.de/. -./tbb30_104oss -============== -Contains parts of the Intel Threading Building Blocks library copyrighted -by the respective authors and licensed under the GNU General Public License -(GPL) Version 2.0 with a runtime exception. See tbb30_104oss/COPYING or -http://threadingbuildingblocks.org/. - -A full version of the tbb project can be downloaded at -http://threadingbuildingblocks.org/. - - -./tbb41_20130401oss -============== +tbb* +---- Contains parts of the Intel Threading Building Blocks library copyrighted by the respective authors and licensed under the GNU General Public License -(GPL) Version 2.0 with a runtime exception. See tbb41_20130401oss/COPYING +(GPL) Version 2.0 with a runtime exception. See `tbb*/COPYING` or http://threadingbuildingblocks.org/. A full version of the tbb project can be downloaded at http://threadingbuildingblocks.org/. -./umfpack (UMFPACK 5.0.2, AMD 2.2, UFCONFIG) -========= +umfpack (UMFPACK 5.0.2, AMD 2.2, UFCONFIG) +------------------------------------------- Contains parts of the UMFPACK, AMD and UFCONFIG libraries copyrighted by Timothy A. Davis, Patrick R. Amestoy, and Iain S. Duff and licensed under the GNU Lesser General Public License version 2.1 or later. Or alternative -licenses as explained in umfpack/UMFPACK/Doc/License and -umfpack/AMD/Doc/License. See umfpack/README.txt and umfpack/lgpl-2.1.txt. +licenses as explained in `umfpack/UMFPACK/Doc/License` and +`umfpack/AMD/Doc/License`. See `umfpack/README.txt` and +`umfpack/lgpl-2.1.txt`. A full version of UMFPACK can be downloaded at http://www.cise.ufl.edu/research/sparse/umfpack/. - diff --git a/cmake/README.cmake b/cmake/README.cmake deleted file mode 100644 index 724cd4d607..0000000000 --- a/cmake/README.cmake +++ /dev/null @@ -1,45 +0,0 @@ -This folder contains the deal.II CMake build system - -Extensive documentation can be found at /doc/development/cmake-internals.html - -It is structured as follows: - -./checks -======== - -Contains checks for platform features and compiler bugs and features - -./config -======= - -Contains configuration templates for - - the project configuration (deal.IIConfig.cmake) - - the legacy Make.global_options mechanism - - the C++ template expansion mechanism (template-arguments) - -./configure -=========== - -Contains files configure_.cmake for configuration and setup of -all features the deal.II library supports - -./macros -======== - -CMake script macros for several purposes - -./modules -========= - -Contains Find.cmake modules for finding external libraries - -./scripts -========= - -Contains script files needed for the build system, notably expand_instantiations - - -./setup_*.cmake -=============== - -Setup files included by the top level CMakeLists.txt file diff --git a/cmake/README.md b/cmake/README.md new file mode 100644 index 0000000000..a840fb69ec --- /dev/null +++ b/cmake/README.md @@ -0,0 +1,47 @@ +This folder contains the deal.II CMake build system +=================================================== + +Extensive documentation can be found at +`/doc/development/cmake-internals.html` + +It is structured as follows: + +checks +------ + +Contains checks for platform features and compiler bugs and features + +config +------ + +Contains configuration templates for + + * the project configuration (deal.IIConfig.cmake) + * the legacy Make.global_options mechanism + * the C++ template expansion mechanism (template-arguments) + +configure +--------- + +Contains files `configure_.cmake` for configuration and setup of +all features the deal.II library supports + +macros +------ + +CMake script macros for several purposes + +modules +------- + +Contains `Find.cmake` modules for finding external libraries + +scripts +------- + +Contains script files needed for the build system, notably expand_instantiations + +setup_*.cmake +------------- + +Setup files included by the top level `CMakeLists.txt` file diff --git a/contrib/README.contrib b/contrib/README.md similarity index 63% rename from contrib/README.contrib rename to contrib/README.md index c3eb2515de..7b375eec07 100644 --- a/contrib/README.contrib +++ b/contrib/README.md @@ -1,28 +1,29 @@ This folder contains contributions to the deal.II library +========================================================= -PLEASE NOTE THAT THESE PROJECTS MAY be COPYRIGHTED BY OTHERS THAN THE +**PLEASE NOTE THAT THESE PROJECTS MAY be COPYRIGHTED BY OTHERS THAN THE deal.II AUTHORS, but are included by permission. For details, consult the -stated licenses below. +stated licenses below.** mesh_conversion -=============== +--------------- Is a program originally written by Jean-Paul Pelteret and licensed under the GNU General Public License (GPL) Version 2.0. See -mesh_conversion/README.txt, mesh_conversion/gpl-2.0.txt. +`mesh_conversion/README.txt`, `mesh_conversion/gpl-2.0.txt`. parameter_gui -============= +------------- Is a program written by Martin Steigemann and Wolfgang Bangerth and licensed under the GNU Lesser General Public License (LGPL) Version 2.1 or -later. See parameter_gui/README, parameter_gui/lgpl-2.1.txt. +later. See `parameter_gui/README`, `parameter_gui/lgpl-2.1.txt`. utilities -========= +--------- A collection of small programs for various purposes. Distributed under the same license as the deal.II library. diff --git a/doc/README.doc b/doc/README.md similarity index 57% rename from doc/README.doc rename to doc/README.md index b3b1fd0c96..33f0385aad 100644 --- a/doc/README.doc +++ b/doc/README.md @@ -1,9 +1,10 @@ This folder contains the html documentation of deal.II +====================================================== The documentation is generally covered by the same license as the deal.II library itself, namely LGPL-2.1+. Exceptions: - external-libraries/p4est-setup.sh - coming from the p4est project, GPL-2+ + `external-libraries/p4est-setup.sh` - coming from the p4est project, GPL-2+ diff --git a/examples/README.example b/examples/README.md similarity index 74% rename from examples/README.example rename to examples/README.md index 1f4f838258..df0842fd14 100644 --- a/examples/README.example +++ b/examples/README.md @@ -1,4 +1,5 @@ This folder contains example programs for deal.II +------------------------------------------------- They are distributed under the same license as the deal.II library itself, namely LGPL-2.1+. diff --git a/tests/README b/tests/README deleted file mode 100644 index 7fbfbe1e99..0000000000 --- a/tests/README +++ /dev/null @@ -1,5 +0,0 @@ -Further information: - - The testsuite documentation is located at - ../doc/developers/testsuite.html. - Alternatively, have a look at http://www.dealii.org/ diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000000..081384bc44 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,5 @@ +Further information: +-------------------- + +The testsuite documentation is located at `../doc/developers/testsuite.html`. +Alternatively, have a look at http://www.dealii.org/