diff --git a/Installation/README b/Installation/README deleted file mode 100644 index be07977a7c6f..000000000000 --- a/Installation/README +++ /dev/null @@ -1,32 +0,0 @@ -README -------------------------------------------------------------------------------- - -This distribution of CGAL includes: - - AUTHORS - current and former authors of CGAL - CHANGES - history of changes for the library - CMakeLists.txt - main script of the build system - INSTALL.md - information about the installation process - LICENSE - describes the license of CGAL - LICENSE.FREE_USE - text of the free use license (see LICENSE file) - LICENSE.GPL - text of GPL v3 license - LICENSE.LGPL - text of LGPL v3 license - README - this file - VERSION - version number of this release - auxiliary/ - directory containing miscellaneous things, currently only - the icons needed for the demos on MacOS X - cmake/ - some scripts needed by the build system - config/ - some test programs used during the configuration process - demo/ - many demo programs for the library's various packages. - These programs produce visual output (see INSTALL for - prerequisites). - doc_html/ - documentation, e.g. the CGAL Installation Guide - examples/ - programs illustrating the library's functionality. - These programs do not produce visual output. - include/ - the include files for the CGAL library (and other small - external libraries as well, see the LICENSE file) - scripts/ - some useful scripts for CGAL programmers - src/ - the source code for building the CGAL libraries - (as well as some external libraries, see the LICENSE file) - -------------------------------------------------------------------------------- diff --git a/Installation/README.md b/Installation/README.md new file mode 100644 index 000000000000..47b4058ec3f7 --- /dev/null +++ b/Installation/README.md @@ -0,0 +1,32 @@ +README +====== + +This distribution of CGAL includes: + +| File or directory | Description | +|-------------------|--------------------------------------------------------------------------------------------------| +| `AUTHORS` | current and former authors of CGAL | +| `CHANGES.md` | history of changes of CGAL | +| `CGALConfig.cmake`| [CMake package] configuration file for CGAL | +| `CGALConfigVersion.cmake` | [CMake package] version file for CGAL | +| `CMakeLists.txt` | main CMake project configuration file | +| `INSTALL.md` | information about the installation process | +| `LICENSE` | describes the license of CGAL | +| `LICENSE.BSL` | text of the Boost Software License (BSL) license | +| `LICENSE.COMMERCIAL` | text of the GeometryFactory Commercial license | +| `LICENSE.GPL` | text of the GNU General Public License (GPL) v3 license | +| `LICENSE.LGPL` | text of the GNU Lesser General Public License (LGPL) v3 license | +| `LICENSE.RFL` | text of the ETH Zurich Random Forest algorithm License (RFL) license | +| `README.md` | this file | +| `VERSION` | version number of this release of CGAL | +| `auxiliary/` | directory containing miscellaneous things, such as icons needed for the demos on macOS | +| `cmake/` | some scripts needed by the CMake build system | +| `data/` | directory containing various geometric data used by examples and demos of CGAL | +| `demo/` | many demo programs for the various packages of CGAL. These programs produce visual output. | +| `doc_html/` | documentation, such as the CGAL Installation Guide | +| `examples/` | programs illustrating the usage of various packages of CGAL. | +| `include/` | the include files for the CGAL library (as well as small external libraries, see the file `LICENSE`) | +| `lib/` | contains [CMake package] configuration files for CGAL | +| `scripts/` | some useful scripts for CGAL programmers | + +[CMake package]: https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html