Add a minimal README file.

1 files changed, 38 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..2e916bf
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+PMS Test Suite
+==============
+
+A GSoC 2011 project by Michał Górny.
+
+http://www.gentoo.org/proj/en/qa/pms/pms-test-suite.xml
+
+
+Few words of introduction
+-------------------------
+
+The PMS Test Suite projects aims to create a comprehensive, universal test suite
+for Gentoo Package Managers. It is supposed to create a set of test ebuilds, run
+them using a particular Package Manager (like portage) and check their results
+to determine whether the PM does comply to the PMS [1].
+
+[1]:http://www.gentoo.org/proj/en/qa/pms.xml
+
+
+How to run it
+-------------
+
+The code is currently in early stage of development, you can try out some
+of the functions already implemented.
+
+First you need to clone the two necessary git repos:
+
+	git clone git://git.overlays.gentoo.org/proj/pms-test-suite.git
+	git clone git://git.overlays.gentoo.org/proj/pms-test-suite-overlay.git
+
+Then run the `ebuild-generator` script, passing the path to the overlay as its
+only argument:
+
+	cd pms-test-suite
+	./ebuild-generator ../pms-test-suite-overlay
+
+
+<!-- vim:se syn=markdown :-->