####################
modCAM documentation
####################

ModCAM is free and open source software for computer aided manufacturing (CAM)
research. It is a library of algorithms for the control of manufacturing
machinery, such as lathes, mills, and 3D printers.

ModCAM's goal is to make the development of new CAM algorithms easier by
providing a library of existing algorithms to build from and by giving
researchers a place to share their code. The intent is to automate additive and,
especially, subtractive manufacturing, making these fields more accessible for
both professionals and hobbyists.

.. toctree::
   :caption: Reference
   :titlesonly:

   C++ library <https://modcam-docs.readthedocs.io/projects/modcam-cpp/>
   Python module <https://modcam-docs.readthedocs.io/projects/modcam-python/>

*******
License
*******

This documentation is licensed under
`Creative Commons Attribution-ShareAlike 4.0 International`_ (CC BY-SA 4.0),
with the following exception: Any code examples detailing the use of modCAM
software are licensed under `CC0 1.0 Universal`_ (CC0). When sharing or adapting
this documentation, you are bound by the CC BY-SA 4.0, but you are free to use
the code examples in your own projects without restriction, conditions, or
expectation of attribution.

.. ATTENTION::
   Only the documentation is licensed under CC BY-SA 4.0. ModCAM software is
   licensed under the `Mozilla Public License Version 2.0`_.

.. _Mozilla Public License Version 2.0: https://www.mozilla.org/en-US/MPL/2.0/

.. _Creative Commons Attribution-ShareAlike 4.0 International: https://creativecommons.org/licenses/by-sa/4.0/

.. _CC0 1.0 Universal: https://creativecommons.org/publicdomain/zero/1.0/