[projects/cleanbuild] add general readme

[glen]

commit 9e30f3ce170c64c28b9dd678f846d292045e698d
Author: Elan Ruusamäe <glen at pld-linux.org>
Date:   Sun Jun 18 20:48:38 2017 +0300

    add general readme

 README | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
---
diff --git a/README b/README
new file mode 100644
index 0000000..a412694
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+cleanbuild
+
+cleanbuild is tool to help discovering missing (or excessive) dependencies by
+building packages in clean build environment.
+
+cleanbuild comes with two backends:
+- vserver (legacy)
+- docker
+
+See README.vserver or README.docker for engine specific instructions.
+
+Run cleanbuild:
+
+  ./cleanbuild FHS
+
+You can create yourself alias for easier invocation from regular user:
+  alias cleanbuild='_cleanbuild() { sudo -H -u builder sh -c "cd ~/cleanbuild && ./cleanbuild $*"; }; _cleanbuild'
+  cleanbuild somepkg
================================================================

---- gitweb:

http://git.pld-linux.org/gitweb.cgi/projects/cleanbuild.git/commitdiff/499402e2ffaebc9ad2ba9c5040e7e2673087d855