From b6ae293b24639d824168b9fa0b1e86d9bc3b19fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 10 Mar 2013 23:54:02 +0100 Subject: [PATCH] Relicensing to MIT/Expat license, part 6: mention it in documentation. --- CONTRIBUTING.md | 72 +++++++++++++++++++++++++++--------------------- README.md | 6 ++++ doc/mainpage.dox | 26 +++++++++++++++++ 3 files changed, 73 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d55a03a71..ec263025d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,41 +4,51 @@ 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/issues), but you can contact me - also any other way. +* Best way to report bugs and request new features is to use GitHub + [issues](https://github.com/mosra/magnum/issues), but you can contact me + also any other way. Code contribution ----------------- -- Building and installing Magnum is described in the - [documentation](http://mosra.cz/blog/magnum-doc/building.html). -- Follow the project coding guidelines. In short - try to match style of - surrounding code and avoid any trailing whitespace. When in doubt, consult - coding guidelines, which are available also - [online](http://mosra.cz/blog/magnum-doc/coding-style.html). -- Document your code. When updating or adding new API, make sure that Doxygen - documentation is up to date. Run - - doxygen - - in project root to generate the documentation and check that your - modifications didn't add any warnings. -- Build unit tests (`-DBUILD_TESTS=ON` parameter to CMake) and run them - using - - ctest --output-on-failure - - in build directory. All tests should always pass. Add new tests or modify - the existing to make sure new code is properly covered (if possible). Here - is a [short tutorial](http://mosra.cz/blog/corrade-doc/unit-testing.html) to - help you with creating unit tests. -- Best way to contribute is by using GitHub - [pull requests](https://github.com/mosra/magnum/pulls) - fork the repository - and make pull request from feature branch. You can also send patches via - e-mail or contact me any other way. -- All your code will be released under license of the project, so make sure - you (or your employers) have no problems with it. +* Building and installing Magnum is described in the [documentation](http://mosra.cz/blog/magnum-doc/building.html). +* Follow the project coding guidelines. In short -- try to match style of the + surrounding code and avoid any trailing whitespace. When in doubt, consult + coding guidelines, which are available also [online](http://mosra.cz/blog/magnum-doc/coding-style.html). +* Document your code. When updating or adding new API, make sure that Doxygen + documentation is up to date. Run + + doxygen + + in project root to generate the documentation and check that your + modifications didn't add any warnings. +* Build unit tests (`-DBUILD_TESTS=ON` parameter to CMake) and run them + using + + ctest --output-on-failure + + in build directory. All tests should *always* pass. Add new tests or modify + the existing to make sure new code is properly covered (if possible). Here + is a [short tutorial](http://mosra.cz/blog/corrade-doc/unit-testing.html) + to help you with creating unit tests. +* Best way to contribute is by using GitHub [pull requests](https://github.com/mosra/magnum/pulls) + -- fork the repository and make pull request from feature branch. You can + also send patches via e-mail or contact me any other way. +* All your code will be released under license of the project (see [COPYING](COPYING) + file for details), so make sure you and your collaborators (or employers) + have no problems with it. If you create new files, don't forget to add + license header (verbatim copied from other files) and don't forget to add + yourself to license header of files you added or significantly modified, + for example: + + /* + This file is part of Magnum. + + Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš + Copyright © YEAR YOUR_NAME + + Permission is hereby granted, free of charge, to any person obtaining a + ... Contact ------- diff --git a/README.md b/README.md index 5b378b3aa..1164a9484 100644 --- a/README.md +++ b/README.md @@ -102,3 +102,9 @@ awesome idea? Feel free to visit my website or contact me at: * GitHub - https://github.com/mosra/magnum * E-mail - mosra@centrum.cz * Jabber - mosra@jabbim.cz + +LICENSE +======= + +Magnum is licensed under MIT/Expat license, see [COPYING](COPYING) file for +details. diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 03ca9e2d3..d9233a841 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -93,5 +93,31 @@ Feel free to get more information or contact the author at: - E-mail - mosra@centrum.cz - Jabber - mosra@jabbim.cz +@section license License + +%Magnum is licensed under MIT/Expat license: + +> +> Copyright © 2010, 2011, 2012, 2013 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. +> + */ }