mirror of https://github.com/CGAL/cgal
transform to a table, and document CMake files
This commit is contained in:
parent
4e11df578f
commit
24a009f933
|
|
@ -3,27 +3,30 @@ README
|
||||||
|
|
||||||
This distribution of CGAL includes:
|
This distribution of CGAL includes:
|
||||||
|
|
||||||
- `AUTHORS`: current and former authors of CGAL
|
| File or directory | Description |
|
||||||
- `CHANGES.md`: history of changes of CGAL
|
|-------------------|--------------------------------------------------------------------------------------------------|
|
||||||
- `CGALConfig.cmake`:
|
| `AUTHORS` | current and former authors of CGAL |
|
||||||
- `CGALConfigVersion.cmake`:
|
| `CHANGES.md` | history of changes of CGAL |
|
||||||
- `CMakeLists.txt`: main CMake project configuration file
|
| `CGALConfig.cmake`| [CMake package] configuration file for CGAL |
|
||||||
- `INSTALL.md`: information about the installation process
|
| `CGALConfigVersion.cmake` | [CMake package] version file for CGAL |
|
||||||
- `LICENSE`: describes the license of CGAL
|
| `CMakeLists.txt` | main CMake project configuration file |
|
||||||
- `LICENSE.BSL`: text of the Boost Software License (BSL) license
|
| `INSTALL.md` | information about the installation process |
|
||||||
- `LICENSE.COMMERCIAL`: text of the GeometryFactory Commercial license
|
| `LICENSE` | describes the license of CGAL |
|
||||||
- `LICENSE.GPL`: text of the GNU General Public License (GPL) v3 license
|
| `LICENSE.BSL` | text of the Boost Software License (BSL) license |
|
||||||
- `LICENSE.LGPL`: text of the GNU LESSER GENERAL PUBLIC License (LGPL) v3 license
|
| `LICENSE.COMMERCIAL` | text of the GeometryFactory Commercial license |
|
||||||
- `LICENSE.RFL`: text of the ETH Zurich Random Forest algorithm License (RFL) license
|
| `LICENSE.GPL` | text of the GNU General Public License (GPL) v3 license |
|
||||||
- `README.md`: this file
|
| `LICENSE.LGPL` | text of the GNU Lesser General Public License (LGPL) v3 license |
|
||||||
- `VERSION`: version number of this release of CGAL
|
| `LICENSE.RFL` | text of the ETH Zurich Random Forest algorithm License (RFL) license |
|
||||||
- `auxiliary/`: directory containing miscellaneous things, such as icons needed for the demos on macOS
|
| `README.md` | this file |
|
||||||
- `cmake/`: some scripts needed by the CMake build system
|
| `VERSION` | version number of this release of CGAL |
|
||||||
- `data/`: directory containing various geometric data used by examples and demos of CGAL
|
| `auxiliary/` | directory containing miscellaneous things, such as icons needed for the demos on macOS |
|
||||||
- `demo/`: many demo programs for the various packages of CGAL. These programs produce visual output.
|
| `cmake/` | some scripts needed by the CMake build system |
|
||||||
- `doc_html/`: documentation, e.g. the CGAL Installation Guide
|
| `data/` | directory containing various geometric data used by examples and demos of CGAL |
|
||||||
- `examples/`: programs illustrating the various packages of CGAL. These programs do not produce visual output.
|
| `demo/` | many demo programs for the various packages of CGAL. These programs produce visual output. |
|
||||||
- `include/`: the include files for the CGAL library (as well as small external libraries, see the file `LICENSE`)
|
| `doc_html/` | documentation, such as the CGAL Installation Guide |
|
||||||
- `lib/`:
|
| `examples/` | programs illustrating the usage of various packages of CGAL. |
|
||||||
- `scripts/`: some useful scripts for CGAL programmers
|
| `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
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue