overlays/default: Add README and equery-licenses

[catalyst-swc.git] / overlays / default / README

diff --git a/overlays/default/README b/overlays/default/README
new file mode 100644 (file)
index 0000000..0199436
--- /dev/null
+++ b/overlays/default/README
@@ -0,0 +1,36 @@
+This distribution was build using open source software and the
+catalyst [1] release-building tool.  For details on the catalyst
+configuration used for this release, see [2].
+
+The packaged projects are distributed under a variety of licenses, and
+were installed using metadata from Gentoo's Portage tree [3] and
+source from Gentoo's mirrors [4].  The full Portage tree is not
+distributed with this release due to size constraints on the release
+media, but you can download a snapshot from the Gentoo mirrors
+directly or by using [5]:
+
+  $ emerge-webrsync
+
+To find the license of a particular installed package, use:
+
+  $ portageq metadata / installed <package> LICENSE
+
+For example:
+
+  $ portageq metadata / installed dev-lang/python-3.2.3 LICENSE
+  PSF-2
+
+The license test is listed in the Portage tree [6], for example [7].
+
+For a listing of all the licenses used by all packages, run:
+
+  $ equery-licenses.py
+
+
+[1]: http://www.gentoo.org/proj/en/releng/catalyst/
+[2]: http://blog.tremily.us/posts/catalyst/
+[3]: http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/
+[4]: http://www.gentoo.org/main/en/mirrors.xml
+[5]: http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=1&chap=6#doc_chap2
+[7]: http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/licenses/
+[8]: http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/licenses/PSF-2?view=markup