Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Installation/README #7959

Merged
merged 2 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 0 additions & 32 deletions Installation/README

This file was deleted.

29 changes: 29 additions & 0 deletions Installation/README.md
Original file line number Diff line number Diff line change
@@ -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`:
lrineau marked this conversation as resolved.
Show resolved Hide resolved
- `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
lrineau marked this conversation as resolved.
Show resolved Hide resolved
- `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
lrineau marked this conversation as resolved.
Show resolved Hide resolved
- `examples/`: programs illustrating the various packages of CGAL. These programs do not produce visual output.
lrineau marked this conversation as resolved.
Show resolved Hide resolved
- `include/`: the include files for the CGAL library (as well as small external libraries, see the file `LICENSE`)
- `lib/`:
lrineau marked this conversation as resolved.
Show resolved Hide resolved
- `scripts/`: some useful scripts for CGAL programmers