Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Relicensing to MIT/Expat license, part 6: mention it in documentation.

  • Loading branch information...
commit 7d2c535be8044615c5992dc316f6f76ba3e23981 1 parent b77effb
@mosra authored
Showing with 75 additions and 31 deletions.
  1. +42 −31 CONTRIBUTING.md
  2. +6 −0 README.md
  3. +27 −0 doc/mainpage.dox
View
73 CONTRIBUTING.md
@@ -4,41 +4,52 @@ 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/corrade/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/corrade/issues), but you can contact me
+ also any other way.
Code contribution
-----------------
-- Building and installing Corrade is described in the
- [documentation](http://mosra.cz/blog/corrade-doc/building-corrade.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/corrade-doc/corrade-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/corrade/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 Corrade is described in the [documentation](http://mosra.cz/blog/corrade-doc/building-corrade.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/corrade-doc/corrade-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/corrade/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 Corrade.
+
+ Copyright © 2007, 2008, 2009, 2010, 2011, 2012, 2013
+ Vladimír Vondruš <mosra@centrum.cz>
+ Copyright © YEAR YOUR_NAME <your@mail.com>
+
+ Permission is hereby granted, free of charge, to any person obtaining a
+ ...
Contact
-------
View
6 README.md
@@ -86,3 +86,9 @@ awesome idea? Feel free to visit my website or contact me at:
* GitHub - http://github.com/mosra/corrade
* E-mail - mosra@centrum.cz
* Jabber - mosra@jabbim.cz
+
+LICENSE
+=======
+
+Corrade is licensed under MIT/Expat license, see [COPYING](COPYING) file for
+details.
View
27 doc/mainpage.dox
@@ -74,5 +74,32 @@ Feel free to get more information or contact the author at:
- E-mail - mosra@centrum.cz
- Jabber - mosra@jabbim.cz
+@section license License
+
+%Corrade is licensed under MIT/Expat license:
+
+>
+> Copyright © 2007, 2008, 2009, 2010, 2011, 2012, 2013
+> Vladimír Vondruš &lt;mosra@centrum.cz&gt;
+>
+> 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.
+>
+
*/
}
Please sign in to comment.
Something went wrong with that request. Please try again.