songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update Installation/README

This commit is contained in:
Mael Rouxel-Labbé 2024-01-03 15:10:06 +01:00
parent 3564fd1851
commit 4e11df578f
2 changed files with 29 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Installation/README
View File

@ -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)
-------------------------------------------------------------------------------

29
Installation/README.md Normal file
View File

@ -0,0 +1,29 @@
README
======
This distribution of CGAL includes:
- `AUTHORS`: current and former authors of CGAL
- `CHANGES.md`: history of changes of CGAL
- `CGALConfig.cmake`:
- `CGALConfigVersion.cmake`:
- `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, e.g. the CGAL Installation Guide
- `examples/`: programs illustrating the various packages of CGAL. These programs do not produce visual output.
- `include/`: the include files for the CGAL library (as well as small external libraries, see the file `LICENSE`)
- `lib/`:
- `scripts/`: some useful scripts for CGAL programmers