[Erp5-report] r42982 rafael - /erp5/trunk/utils/erp5.utils.dists/README.txt

[nobody at svn.erp5.org]

Author: rafael
Date: Thu Feb  3 14:14:18 2011
New Revision: 42982

URL: http://svn.erp5.org?rev=42982&view=rev
Log:
Added usage and examples.

Modified:
    erp5/trunk/utils/erp5.utils.dists/README.txt

Modified: erp5/trunk/utils/erp5.utils.dists/README.txt
URL: http://svn.erp5.org/erp5/trunk/utils/erp5.utils.dists/README.txt?rev=42982&r1=42981&r2=42982&view=diff
==============================================================================
--- erp5/trunk/utils/erp5.utils.dists/README.txt [utf8] (original)
+++ erp5/trunk/utils/erp5.utils.dists/README.txt [utf8] Thu Feb  3 14:14:18 2011
@@ -14,6 +14,20 @@ bt5_repository_builder
   and creates bt5list. 
 
   By default, this uses svn HEAD to compile and provides as same as snapshot.
+  
+  USAGE:
+  -u, --url          :  URL where the business templates will be downloaded from
+                    (Default: https://svn.erp5.org/repos/public/erp5/trunk/bt5,https://svn.erp5.org/repos/public/erp5/trunk/products/ERP5/bootstrap)
+
+  -r, --repository   : Where the .bt5 will be placed (Default: Current folder.)
+
+  -d, --download-dir : Custom folder where download/checkout will be placed.
+                      (Default: repository_folder/.download)
+  -c, --download-cmd : Command used to download bt5 from URL.
+                      (Default: "svn co --trust-server-cert --non-interactive -q")
+
+  -p, --preserve-download : Do not erase download after build. (Default: False)
+
 
 bt5_genlist
 
@@ -23,3 +37,22 @@ bt5_build_from_folder
 
   Only compress all bt5s available into some folder into a destination folder. 
 
+
+USAGE EXAMPLE
+============================
+
+Build bt5 repository from with private business templates.
+
+  $ bt5_repository_builder -u http://url.to/private/repository
+
+Build bt5 repository from a specific revision of SVN.
+
+  $ bt5_repository_builder -c "svn co -q -r 1234"
+
+Create a Snapshot updated everyhour using cron:
+
+  1 * * * * bt5_repository_builder -p -r /srv/www/repository
+
+
+
+