commit eaf753f01dad5ef0c493a3095fb6539123d0116f
Author: Jan Pokorný <jpokorny(a)redhat.com>
Date: Sat Feb 25 19:16:19 2012 +0100
README.txt: document usage of bootstrap script
Signed-off-by: Jan Pokorný <jpokorny(a)redhat.com>
README.txt | 20 +++++++++++++++++++-
1 files changed, 19 insertions(+), 1 deletions(-)
---
diff --git a/README.txt b/README.txt
index 51e5e92..93db649 100644
--- a/README.txt
+++ b/README.txt
@@ -20,7 +20,8 @@ framework.
=========================
In case of using distro-packaged version of `sunzi`, you can skip
-to point ``TODO``.
+to point ``TODO``. If you want to contribute, you may be also
+skip down to point 2.3.
2.1 Dependencies
----------------
@@ -50,6 +51,23 @@ of `setup.cfg` (from the path above) before actually performing
requested
forgot". To preserve a copy of `setup.cfg`, just use `python setup.py`
as usual.
+2.3 Quick start (for contribution)
+----------------------------------
+
+Bootstrap script is the fastest way to start hacking (this will setup
+virtualenv environment in the current dir, modify as per your needs)::
+
+
URL='http://git.fedorahosted.org/git/?p=sunzi.git;a=blob_plain;f=sunz...
+ ENV=.
+ curl $URL | python -c 'import
sys;__file__="_";exec(sys.stdin.read())' $ENV
+
+The whole process may take a while as the steps from 2.2 are being perfomed
+(third-party repositories cloned, etc.).
+
+
+.. TODO: URL may be even static file, e.g., on
fedorapeople.org
+
+
.. ``TODO``
.. Prerequisities for successful build/installation/deployment:
..