README.md
1Here you find extra functionality for the Magnum C++11/C++14 graphics engine —
2playground for testing new APIs, specialized stuff that doesn't necessarily
3need to be a part of main Magnum repository or mutually exclusive
4functionality.
5
6[![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)
7[![Build Status](https://travis-ci.org/mosra/magnum-extras.svg?branch=master)](https://travis-ci.org/mosra/magnum-extras)
8[![Build status](https://ci.appveyor.com/api/projects/status/f75u5eow2qiso7m5/branch/master?svg=true)](https://ci.appveyor.com/project/mosra/magnum-extras/branch/master)
9[![Coverage Status](https://codecov.io/gh/mosra/magnum-extras/branch/master/graph/badge.svg)](https://codecov.io/gh/mosra/magnum-extras)
10[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
11
12- Project homepage — https://magnum.graphics/
13- Documentation — https://doc.magnum.graphics/
14- GitHub project page — https://github.com/mosra/magnum-extras
15
16SUPPORTED PLATFORMS
17===================
18
19- **Linux** and embedded Linux
20- **Windows**, **Windows RT** (Store/Phone)
21- **macOS**, **iOS**
22- **Android**
23- **Web** ([asm.js](http://asmjs.org/) or [WebAssembly](http://webassembly.org/)),
24 through [Emscripten](http://kripken.github.io/emscripten-site/)
25
26WHAT'S NEW?
27===========
28
29Curious about what was added or improved recently? Check out the
30[Changelog](https://doc.magnum.graphics/magnum/changelog-extras.html#changelog-extras-latest)
31page in the documentation.
32
33BUILDING MAGNUM EXTRAS
34======================
35
36The building process is similar to Magnum itself. See the
37[building documentation](https://doc.magnum.graphics/magnum/building-extras.html)
38for a comprehensive guide for building, packaging and crosscompiling — we
39provide packages for many platforms, including Windows, Linux and macOS.
40
41CONTACT & SUPPORT
42=================
43
44If you want to contribute to Magnum, if you spotted a bug, need a feature or
45have an awesome idea, you can get a copy of the sources from GitHub and start
46right away! There is the already mentioned guide about
47[how to download and build Magnum Extras](https://doc.magnum.graphics/magnum/building-extras.html)
48and also a guide about [coding style and best practices](https://doc.magnum.graphics/magnum/coding-style.html)
49which you should follow to keep the library as consistent and maintainable as
50possible.
51
52- Project homepage — https://magnum.graphics/
53- Documentation — https://doc.magnum.graphics/
54- GitHub — https://github.com/mosra/magnum-extras and the
55 [#magnum](https://github.com/topics/magnum) topic
56- GitLab — https://gitlab.com/mosra/magnum-extras
57- Gitter community chat — https://gitter.im/mosra/magnum
58- E-mail — info@magnum.graphics
59- Google Groups mailing list — magnum-engine@googlegroups.com
60 ([archive](https://groups.google.com/forum/#!forum/magnum-engine))
61- Twitter — https://twitter.com/czmosra and the
62 [#MagnumEngine](https://twitter.com/hashtag/MagnumEngine) hashtag
63
64See also the Magnum Project [Contact & Support page](https://magnum.graphics/contact/)
65for further information.
66
67CREDITS
68=======
69
70See the [CREDITS.md](CREDITS.md) file for details. Big thanks to everyone
71involved!
72
73LICENSE
74=======
75
76Magnum is licensed under the MIT/Expat license, see the [COPYING](COPYING) file
77for details.
78