Guidelines

Developer Resources

These guides are meant to be a resource for developers who wish to contribute to the CGAL library either by designing new packages or maintaining or enhancing existing ones. They are organized roughly in the order in which a developer will need the information in order to produce a package for the library. New developers should also read Information for new developers and the public developer manual.

• Developing with Git
  • Quick Start with Git
  • Source Code Management with Git
    • Naming Recommendations
  • Developing Features with Git
  • Git FAQ
• Structure of a CGAL Package
  • Directory Structure for Packages
  • Examples and Demo Programs
• Building
  • Branch Build
  • The CGAL_DEV_MODE Macro
  • Building Dependencies
    • Building boost on windows
    • Building GMP and MPFR on Windows with Visual Studio
  • Advanced Compilation
    • How to use CGAL with CMake or your own build system
    • Cross Compilation of CGAL for Android
    • Linux X86 ARM Cross Compilation
    • Precompiled Headers
• Concurrency in CGAL
• License
• Documentation Guidelines
  • Writing Documentation
  • Building the Documentation
  • Doxygen FAQ
  • Triggering the build of a PR's documentation
• Reviewing Process
  • Submission
  • Tutorial PR for review
• Testing
• Miscellaneous
  • Debug trick with CGAL assertions
  • Use Conan for CGAL on Windows
  • Deprecate headers and functions