overlays/default: Add README and equery-licenses
[catalyst-swc.git] / overlays / default / README
1 This distribution was build using open source software and the
2 catalyst [1] release-building tool.  For details on the catalyst
3 configuration used for this release, see [2].
4
5 The packaged projects are distributed under a variety of licenses, and
6 were installed using metadata from Gentoo's Portage tree [3] and
7 source from Gentoo's mirrors [4].  The full Portage tree is not
8 distributed with this release due to size constraints on the release
9 media, but you can download a snapshot from the Gentoo mirrors
10 directly or by using [5]:
11
12   $ emerge-webrsync
13
14 To find the license of a particular installed package, use:
15
16   $ portageq metadata / installed <package> LICENSE
17
18 For example:
19
20   $ portageq metadata / installed dev-lang/python-3.2.3 LICENSE
21   PSF-2
22
23 The license test is listed in the Portage tree [6], for example [7].
24
25 For a listing of all the licenses used by all packages, run:
26
27   $ equery-licenses.py
28
29
30 [1]: http://www.gentoo.org/proj/en/releng/catalyst/
31 [2]: http://blog.tremily.us/posts/catalyst/
32 [3]: http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/
33 [4]: http://www.gentoo.org/main/en/mirrors.xml
34 [5]: http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=1&chap=6#doc_chap2
35 [7]: http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/licenses/
36 [8]: http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/licenses/PSF-2?view=markup