add --tmpfs=2G to specicify size of build tmpfs size

[projects/cleanbuild.git] / README

diff --git a/README b/README
index a295c3ee530601e226a78a26d8d5a73fdd306c9b..a412694f2d7a29a9424e29dca9e0ea4a9c426a80 100644 (file)
--- a/README
+++ b/README
@@ -1,55 +1,18 @@
-Dependencies:
+cleanbuild
 
-  Missing packages on fresh PLD vserver installation:
+cleanbuild is tool to help discovering missing (or excessive) dependencies by
+building packages in clean build environment.
 
-  cvsnt
-  mount
-  perl-base
-  poldek
-  rpm-build-tools
-  subversion
-  sudo
+cleanbuild comes with two backends:
+- vserver (legacy)
+- docker
 
-Setup:
-
-  # Install all dependencies
-
-  # configure passwordless sudo for user you use for cleanbuild
-  visudo
-  # add something like:
-  # cleanbuilduser        ALL=(ALL) NOPASSWD: ALL
-
-  # create rpm dir
-  builder --init-rpm-dir
-
-  # login to cvs
-  cd ~/rpm/packages
-  cvs login
-  (press enter when asked for password)
-
-  # create directories
-  mkdir ~/rpm/cleanRPMS
-  mkdir ~/rpm/cleanRPMS.repo
-
-  # checkout svn repo
-  svn co http://svn.pld-linux.org/svn/toys/tools/cleanbuild
-
-  # set local user name
-  echo 'USER="cleanbuilduser"' > .cleanbuildrc
-
-Notes for vserver:
-
-  If you are inside vserver, you need to have following context capabilities
-  (add these lines to /etc/vserver/<name>/ccapabilities):
-    SECURE_MOUNT
-    BINARY_MOUNT
-
-  And following system capabilities (add these lines to
-  /etc/vserver/<name>/bcapabilities):
-    MKNOD
-    SYS_ADMIN
+See README.vserver or README.docker for engine specific instructions.
 
 Run cleanbuild:
 
-  cd cleanbuild
-  ./cleanbuild some.spec
+  ./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