mirror of https://github.com/CGAL/cgal
35 lines
1.5 KiB
Plaintext
35 lines
1.5 KiB
Plaintext
/*!
|
|
\page general_intro Getting Started with %CGAL
|
|
|
|
The following pages describe how to use \cgal on different environments:
|
|
|
|
- \subpage usage
|
|
|
|
- \subpage windows
|
|
|
|
- \subpage thirdparty gives information (supported versions, download links) of the required and optional third party libraries.
|
|
|
|
- \subpage devman_create_and_use_a_cmakelist explains how to use CMake to link a program with \cgal.
|
|
|
|
The following pages cover advanced installation options:
|
|
|
|
- \subpage configurationvariables gives information about which CMake variables can be used to help
|
|
resolve missing dependencies while using the cmake command line tool.
|
|
|
|
- \subpage installation describes the process of configuring and installing \cgal.
|
|
|
|
The following pages cover the structure of the manual and general information about \cgal:
|
|
|
|
- \subpage manual gives an idea of where you should look for documentation.
|
|
|
|
- \subpage preliminaries lists how to control inlining, thread safety, code deprecation, checking
|
|
of pre- and postconditions, how to alter the failure behavior, and how to check the version of \cgal.
|
|
|
|
- \subpage license describes the different licenses used within \cgal, with which users must comply.
|
|
|
|
Once you are familiar with building your programs with \cgal and how the documentation is structured,
|
|
you can head over to the \ref tutorials for a gentle introduction to \cgal, or directly to the package(s)
|
|
that interest you the \ref packages. Each package contains simple examples of the various functionalities of the package.
|
|
|
|
*/
|