Browse Source

Add initial README and license.

pull/1/head
Vladimír Vondruš 7 years ago
parent
commit
f7d5d91103
  1. 24
      CONTRIBUTING.md
  2. 20
      COPYING
  3. 8
      CREDITS.md
  4. 52
      README.md

24
CONTRIBUTING.md

@ -0,0 +1,24 @@
Bug reports, feature requests or code contributions are always very welcome.
To make things easier, here are a few tips:
Reporting bugs, requesting features
-----------------------------------
- Best way to report bugs and request new features is to use GitHub
[Issues](https://github.com/mosra/magnum-bindings/issues), but you can
contact the team also any other way — see the [README](README.md) for
details.
Code contribution
-----------------
- Best way to contribute is using GitHub [Pull Requests](https://github.com/mosra/magnum-bindings/pulls)
— fork the repository and make a pull request from a feature branch. You
can also send patches via e-mail or contact the team in any other way — see
the [README](README.md) for details.
- Follow the project coding guidelines. In short — try to match style of the
surrounding code and avoid any trailing whitespace. For C++, there's the
[C++ Coding Style](https://doc.magnum.graphics/magnum/coding-style.html).
- All your code will be released under the project license (see the
[COPYING](COPYING) file for details), so make sure you and your
collaborators (or employers) have no problems with it.

20
COPYING

@ -0,0 +1,20 @@
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019
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.

8
CREDITS.md

@ -0,0 +1,8 @@
Third-party components
----------------------
The following third-party components are used internally:
- The Python bindings make use of the pybind11 library --
https://pybind11.readthedocs.io/, available under a
[BSD-style license](https://github.com/pybind/pybind11/blob/master/LICENSE)

52
README.md

@ -0,0 +1,52 @@
This repository contains bindings of the Magnum C++11/C++14 graphics engine
into other languages such as Python.
[![Join the chat at https://gitter.im/mosra/magnum](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mosra/magnum?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/mosra/magnum-bindings.svg?branch=master)](https://travis-ci.org/mosra/magnum-bindings)
[![Coverage Status](https://codecov.io/gh/mosra/magnum-bindings/branch/master/graph/badge.svg)](https://codecov.io/gh/mosra/magnum-bindings)
[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
- Project homepage — https://magnum.graphics/
- Documentation — https://doc.magnum.graphics/
- GitHub project page — https://github.com/mosra/magnum-bindings
UNDER CONSTRUCTION
==================
Contents of this repository and documentation is under construction. You can
find work-in-progress docs at https://doc.magnum.graphics/doc/magnum.py/ but
there isn't much to look at yet.
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-bindings and the
[#magnum](https://github.com/topics/magnum) topic
- GitLab — https://gitlab.com/mosra/magnum-bindings
- 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))
- Twitter — https://twitter.com/czmosra and the
[#MagnumEngine](https://twitter.com/hashtag/MagnumEngine) hashtag
See also the Magnum Project [Contact & Support page](https://magnum.graphics/contact/)
for further information.
CREDITS
=======
See the [CREDITS.md](CREDITS.md) file for details. Big thanks to everyone
involved!
LICENSE
=======
Magnum is licensed under the MIT/Expat license, see the [COPYING](COPYING) file
for details.
Loading…
Cancel
Save