You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

99 lines
4.6 KiB

..
This file is part of Magnum.
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
2020, 2021, 2022, 2023, 2024, 2025, 2026
Vladimír Vondruš <mosra@centrum.cz>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
..
Magnum Python bindings
######################
*Lightweight and modular graphics middleware for games and data visualization.*
This site documents the Python bindings for the Magnum project. To see
high-level feature overview, project goals or read the developer blog, head
over to the `project homepage <https://magnum.graphics>`_.
`Getting started`_
==================
Because it's out of human capabilities to maintain the Python documentation at
the same scale as the C++ documentation including all math equations, best
practices and such, most of the Python documentation is written as a delta to
the C++ docs --- highlighting important differences and describing general
conventions, but referring to documentation of underlying C++ APIs for all
details.
See the :ref:`building docs <std:doc:building>` for an installation guide,
:ref:`API convention documentation <std:doc:api-conventions>` and
:ref:`documentation of each module <std:special:modules>` for more information about
the actual usage. There are also :ref:`examples <std:doc:examples>` to give you
an idea about how the API feels.
`Contact & support`_
====================
If you want to contribute to Magnum, if you spotted a bug, need a feature or
have an awesome idea, you can get a copy of the sources from GitHub and start
right away!
- Project homepage --- https://magnum.graphics/
- Documentation --- https://doc.magnum.graphics/
- GitHub --- https://github.com/mosra/magnum and the
`\#magnum <https://github.com/topics/magnum>`_ topic
- GitLab --- https://gitlab.com/mosra/magnum
- Gitter community chat --- https://gitter.im/mosra/magnum
- E-mail --- info@magnum.graphics
- Google Groups mailing list --- magnum-engine@googlegroups.com
(`archive <https://groups.google.com/forum/#!forum/magnum-engine>`_)
- Bluesky --- https://bsky.app/profile/mosra.cz
See also the `Contact & Support page <https://magnum.graphics/contact/>`_ on
the project website for further information.
`License`_
==========
Magnum, including the Python bindings, is licensed under the MIT/Expat license:
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
2020, 2021, 2022, 2023, 2024, 2025, 2026 Vladimír Vondruš
<mosra@centrum.cz> and contributors
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.