aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..4e9e612
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+About
+-----
+This is a simple plugin to provide useful Gentoo functionality to rbot.
+
+Requirements
+------------
+- Gentoo system
+- dev-python/celementtree
+- Full portage tree pointed to by PORTDIR in /etc/make.conf
+
+Licensing
+---------
+The plugin is released under the Affero General Public License 3 (or
+at your option, any later version). For this reason, the "zilla
+source" download will report the URL where to download the source.
+
+If you make any change to the source code, you should then make them
+available, and change the plugin_sources function accordingly.