Skip to content

Commit 52d2256

Browse files
committed
Moved credits into the documentation.
Nobody ever looked into the CREDITS.md file anyway and we want to be clear about licenses to our commercial users.
1 parent 8365f65 commit 52d2256

File tree

4 files changed

+122
-30
lines changed

4 files changed

+122
-30
lines changed

CREDITS.md

+8-28
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,11 @@
1-
Contributors to Corrade library
2-
-------------------------------
1+
Third-party components
2+
----------------------
33

4-
Listing only people with code contributions, because otherwise there's too many
5-
:) Big thanks to everyone involved!
4+
Third party components that affect public usage of the project are listed
5+
[in the documentation](https://doc.magnum.graphics/corrade/corrade-credits-third-party.html).
66

7-
- Alexander F Rødseth ([@xyproto](https://github.com/xyproto)) -- packages in
8-
the ArchLinux community repository
9-
- Alexey Yurchenko ([@alexesDev](https://github.com/alexesDev)) -- static
10-
analyis, bug reports
11-
- [@biosek](https://github.com/biosek)) -- MinGW compilation fixes
12-
- David Lin ([@davll](https://github.com/davll)) -- initial macOS port
13-
- Chris Chambers ([@chris-chambers](https://github.com/chris-chambers)) --
14-
interfacing `Debug` with `std::ostream` operators
15-
- Eliot Saba ([@staticfloat](https://github.com/staticfloat)) -- macOS
16-
buildsystem fixes
17-
- [@jaynus](https://github.com/jaynus)) -- MSVC compilation fixes
18-
- Michael Dietschi ([@mdietsch](https://github.com/mdietsch)) -- support for
19-
colored output in Win32 console
20-
- Nathan Ollerenshaw ([@matjam](https://github.com/matjam)) -- Ubuntu
21-
packages in a PPA repository
22-
- Nicholas "LB" Branden ([@LB--](https://github.com/LB--)) -- bugfixes,
23-
design suggestions
24-
- Olga Turanksaya ([@olga-python](https://github.com/olga-python)) -- gentoo
25-
ebuild
26-
- [@sigman78](https://github.com/sigman78) -- initial MSVC 2017 port, Vcpkg
27-
packages
28-
- [@xantares](https://github.com/xantares) -- Windows port improvements
7+
Contributors to Corrade
8+
-----------------------
299

30-
Is this list missing your name or something's wrong?
31-
[Let us know!](https://magnum.graphics/contact/)
10+
[Detailed contributor list](https://doc.magnum.graphics/corrade/corrade-credits-contributors.html)
11+
is maintained in the documentation. Big thanks to everyone involved!

doc/00-page-order.dox

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ namespace Corrade {
3636
@m_keyword{Partially supported features,,}
3737
@page corrade-changelog Changelog
3838
@page corrade-changelog-old Archived changelogs
39-
4039
@page corrade-developers Developers guide
4140
@page corrade-coding-style Coding style
42-
41+
@page corrade-credits-third-party Third-party components
42+
@page corrade-credits-contributors Contributors
4343
@page corrade-debugoperators Debug output operators for custom types
4444

4545
See also @ref corrade-configurationvalues and @ref corrade-tweakableliterals.

doc/corrade-credits.dox

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
/*
2+
This file is part of Corrade.
3+
4+
Copyright © 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016,
5+
2017, 2018 Vladimír Vondruš <[email protected]>
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a
8+
copy of this software and associated documentation files (the "Software"),
9+
to deal in the Software without restriction, including without limitation
10+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
11+
and/or sell copies of the Software, and to permit persons to whom the
12+
Software is furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included
15+
in all copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20+
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23+
DEALINGS IN THE SOFTWARE.
24+
*/
25+
26+
namespace Corrade {
27+
28+
/** @page corrade-credits-third-party Third-party components
29+
@brief Third-party dependencies and their corresponding license information
30+
31+
This page lists libraries, data files and other components that some Corrade
32+
libraries, plugins, executables or tests depend on. See the
33+
@ref corrade-mainpage-license "main page" for license of Corrade itself. For
34+
easier overview the dependencies are color-coded:
35+
36+
- A @m_class{m-label m-dim} **dim** or no label marks dependencies that have
37+
no license requirements, such as usage of public APIs like Vulkan or OpenAL
38+
or usage of platform-specific interfaces.
39+
- A @m_class{m-label m-success} **green** label marks licenses that make the
40+
dependency safe to use in a commerical setting without having to release
41+
your source code, usually requiring you to give attribution.
42+
- A @m_class{m-label m-primary} **light blue** label marks public domain
43+
software. In some countries there's no notion of public domain, in which
44+
case there might be a fallback license as well.
45+
- A @m_class{m-label m-warning} **yellow** label marks licenses that require
46+
you to either dynamically link to the software to be able to use it in a
47+
commercial setting or release your source code as well. In some cases there
48+
is an alternative commercial licensing option without this requirement.
49+
- A @m_class{m-label m-danger} **red** label marks licenses that
50+
unconditionally require you to publish your software together with its
51+
source code. In some cases there is an alternative commercial licensing
52+
option without this requirement.
53+
54+
Documentation of each linked library / plugin / executable has more detailed
55+
information about the dependencies used. Especially in case of plugins in most
56+
cases there are alternative implementations with different licensing
57+
requirements. Please note that it's not guaranteed that the licensing info
58+
provided is in any way accurate or complete, you should always check with a
59+
lawyer to be sure.
60+
61+
There's also a list of @ref corrade-credits-contributors "people and organizations that contributed to Corrade".
62+
63+
- - -
64+
65+
@m_class{m-text-center m-text m-dim}
66+
67+
There are no third party components used at the moment.
68+
69+
*/
70+
71+
/** @page corrade-credits-contributors Contributors
72+
@brief People and organizations that contributed to Corrade
73+
74+
Listing only people with code contributions or other significant work, because
75+
otherwise there's too many :) There's also a list of
76+
@ref corrade-credits-third-party "third party components with their license info".
77+
Big thanks to everyone involved!
78+
79+
@m_class{m-text-center m-text m-dim}
80+
81+
Is the below list missing your name or something's wrong?
82+
[Let us know!](https://magnum.graphics/contact/)
83+
84+
- **Alexander F Rødseth** ([\@xyproto](https://github.com/xyproto)) ---
85+
packages in the ArchLinux community repository
86+
- **Alexey Yurchenko** ([\@alexesDev](https://github.com/alexesDev)) ---
87+
static analyis, bug reports
88+
- **[\@biosek](https://github.com/biosek)** --- MinGW compilation fixes
89+
- **David Lin** ([\@davll](https://github.com/davll)) --- initial macOS port
90+
- **Chris Chambers** ([\@chris-chambers](https://github.com/chris-chambers))
91+
--- interfacing @ref Utility::Debug with @ref std::ostream operators
92+
- **Eliot Saba** ([\@staticfloat](https://github.com/staticfloat)) --- macOS
93+
buildsystem fixes
94+
- **[\@jaynus](https://github.com/jaynus)** --- MSVC compilation fixes
95+
- **Michael Dietschi** ([\@mdietsch](https://github.com/mdietsch)) ---
96+
support for colored output in Win32 console
97+
- **Nathan Ollerenshaw** ([\@matjam](https://github.com/matjam)) --- Ubuntu
98+
packages in a PPA repository
99+
- **Nicholas "LB" Branden** ([\@LB--](https://github.com/LB--)) --- bugfixes,
100+
design suggestions
101+
- **Olga Turanksaya** ([\@olga-python](https://github.com/olga-python)) ---
102+
gentoo ebuild
103+
- **[\@sigman78](https://github.com/sigman78)** --- initial MSVC 2017 port,
104+
Vcpkg packages
105+
- **[\@xantares](https://github.com/xantares)** --- Windows port improvements
106+
*/
107+
108+
}

doc/mainpage.dox

+4
Original file line numberDiff line numberDiff line change
@@ -93,5 +93,9 @@ Corrade is licensed under the MIT/Expat license:
9393
> DEALINGS IN THE SOFTWARE.
9494
>
9595

96+
All example code is released into public domain, see @ref corrade-example-index
97+
for more information. Some Corrade libraries depend on third-party components,
98+
see @ref corrade-credits-third-party for their respective licenses. There's
99+
also a @ref corrade-credits-contributors "list of contributors".
96100
*/
97101
}

0 commit comments

Comments
 (0)