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
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/.
-
+++ /dev/null
-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_<feature>.cmake for configuration and setup of
-all features the deal.II library supports
-
-./macros
-========
-
-CMake script macros for several purposes
-
-./modules
-=========
-
-Contains Find<Library>.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
--- /dev/null
+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_<feature>.cmake` for configuration and setup of
+all features the deal.II library supports
+
+macros
+------
+
+CMake script macros for several purposes
+
+modules
+-------
+
+Contains `Find<Library>.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
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.
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+
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+.
+++ /dev/null
-Further information:
-
- The testsuite documentation is located at
- ../doc/developers/testsuite.html.
- Alternatively, have a look at http://www.dealii.org/
--- /dev/null
+Further information:
+--------------------
+
+The testsuite documentation is located at `../doc/developers/testsuite.html`.
+Alternatively, have a look at http://www.dealii.org/
projects / dealii.git / commitdiff