+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 one:
-Configure compile and install the deal.II library with:
+ 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<N> install)
+
+ A detailed ReadME can be found at ./doc/readme.html and
+ ./doc/development/cmake.html or at http://www.dealii.org/.
+
+Getting started:
- $ mkdir build
- $ cd build
- $ cmake -DCMAKE_INSTALL_PREFIX=/path/where/deal.II/should/be/intalled/to ..
- $ make install (alternatively $ make -j<N> install)
+ 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/.
-A detailed ReadME can be found at
- doc/readme.html and
- doc/development/cmake.html
-or at
- http://dealii.org/.
+For further information have a look at ./doc/readme.html or at
+http://www.dealii.org.
#
# DEAL_II_PATH *)
# DEAL_II_CMAKE_MACROS_RELDIR *)
-# DEAL_II_DOCUMENTATION_RELDIR *)
+# DEAL_II_DOCHTML_RELDIR *)
+# DEAL_II_DOCREADME_RELDIR *)
# DEAL_II_EXAMPLES_RELDIR *)
# DEAL_II_EXECUTABLE_RELDIR *)
# DEAL_II_INCLUDE_RELDIR *)
SET_IF_EMPTY(DEAL_II_PACKAGE_VERSION "8.0.pre") # TODO: Get this value from somewhere else
-SET_IF_EMPTY(DEAL_II_PACKAGE_VENDOR "http://www.dealii.org/")
+SET_IF_EMPTY(DEAL_II_PACKAGE_VENDOR "The deal.II Authors <http://www.dealii.org/>")
STRING(REGEX REPLACE
"^([0-9]+)\\..*" "\\1" DEAL_II_VERSION_MAJOR "${DEAL_II_PACKAGE_VERSION}"
#
SET_IF_EMPTY(DEAL_II_CMAKE_MACROS_RELDIR "cmake/macros")
SET_IF_EMPTY(DEAL_II_COMMON_RELDIR "common")
- SET_IF_EMPTY(DEAL_II_DOCUMENTATION_RELDIR "doc")
+ SET_IF_EMPTY(DEAL_II_DOCREADME_RELDIR "")
+ SET_IF_EMPTY(DEAL_II_DOCHTML_RELDIR "doc")
SET_IF_EMPTY(DEAL_II_EXAMPLES_RELDIR "examples")
SET_IF_EMPTY(DEAL_II_EXECUTABLE_RELDIR "bin")
SET_IF_EMPTY(DEAL_II_INCLUDE_RELDIR "include")
#
SET_IF_EMPTY(DEAL_II_CMAKE_MACROS_RELDIR "share/${DEAL_II_PACKAGE_NAME}/cmake/Macros")
SET_IF_EMPTY(DEAL_II_COMMON_RELDIR "share/${DEAL_II_PACKAGE_NAME}/common")
- SET_IF_EMPTY(DEAL_II_DOCUMENTATION_RELDIR "share/doc/${DEAL_II_PACKAGE_NAME}/html")
+ SET_IF_EMPTY(DEAL_II_DOCREADME_RELDIR "share/doc/${DEAL_II_PACKAGE_NAME}")
+ SET_IF_EMPTY(DEAL_II_DOCHTML_RELDIR "${DEAL_II_DOCREADME_RELDIR}/html")
SET_IF_EMPTY(DEAL_II_EXAMPLES_RELDIR "share/doc/${DEAL_II_PACKAGE_NAME}/examples")
SET_IF_EMPTY(DEAL_II_EXECUTABLE_RELDIR "bin")
SET_IF_EMPTY(DEAL_II_INCLUDE_RELDIR "include")
# Install the static elements of the html documentation:
#
INSTALL(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/
- DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}
+ DESTINATION ${DEAL_II_DOCHTML_RELDIR}
COMPONENT documentation
PATTERN "CMakeLists.txt" EXCLUDE
PATTERN "doxygen" EXCLUDE
)
INSTALL(FILES
${CMAKE_CURRENT_BINARY_DIR}/title.html
- DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}
+ DESTINATION ${DEAL_II_DOCHTML_RELDIR}
COMPONENT documentation
)
ENDIF(DEAL_II_COMPONENT_DOCUMENTATION)
+#
+# Always install a minimalistic README and LICENSE file:
+#
+SET(_destination)
+INSTALL(FILES
+ ${CMAKE_SOURCE_DIR}/README
+ ${CMAKE_SOURCE_DIR}/LICENSE
+ DESTINATION ${CMAKE_INSTALL_PREFIX}/${DEAL_II_DOCREADME_RELDIR}
+ COMPONENT library
+ )
# )
#
# SET(DEAL_II_COMPONENT_DOCUMENTATION OFF CACHE BOOL
-# "Enable configuration, build and installation of the documentation. This adds a COMPONENT \"documentation\" to the build system."
+# "Enable configuration, build and installation of the html documentation. This adds a COMPONENT \"documentation\" to the build system."
# )
#
# SET(DEAL_II_COMPONENT_EXAMPLES ON CACHE BOOL
# "Relative installation directory for macros"
# )
#
-# SET(DEAL_II_DOCUMENTATION_RELDIR "doc" CACHE STRING
+# SET(DEAL_II_DOCHTML_RELDIR "doc" CACHE STRING
# "Relative installation directory for html documentation"
# )
#
+# SET(DEAL_II_DOCREADME_RELDIR "" CACHE STRING
+# "Relative installation directory for readme"
+# )
+#
# SET(DEAL_II_EXAMPLES_RELDIR "examples" CACHE STRING
# "Relative installation directory for examples"
# )
INSTALL(FILES
${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css
- DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}/doxygen
+ DESTINATION ${DEAL_II_DOCHTML_RELDIR}/doxygen
COMPONENT documentation
)
INSTALL(DIRECTORY
${CMAKE_CURRENT_BINARY_DIR}/deal.II
- DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}/doxygen
+ DESTINATION ${DEAL_II_DOCHTML_RELDIR}/doxygen
COMPONENT documentation
)
toc-topics.html
${CMAKE_CURRENT_BINARY_DIR}/steps.png
${CMAKE_CURRENT_BINARY_DIR}/toc.html
- DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}/doxygen/tutorial
+ DESTINATION ${DEAL_II_DOCHTML_RELDIR}/doxygen/tutorial
COMPONENT documentation
)