commit 66bddb0a83c943242ce760f609ee0ebab40fe32a
Author: Jan Pokorný <jpokorny(a)redhat.com>
Date: Mon Feb 27 02:24:34 2012 +0100
README.*: better cross-reference, mention yolk
Signed-off-by: Jan Pokorný <jpokorny(a)redhat.com>
README.contrib | 3 ++-
README.txt | 6 +++++-
2 files changed, 7 insertions(+), 2 deletions(-)
---
diff --git a/README.contrib b/README.contrib
index bc2842d..32b722a 100644
--- a/README.contrib
+++ b/README.contrib
@@ -10,7 +10,8 @@ I. GIT usage/patches
Get started
-----------
-Follow `README.txt`, Using upstream code, and as a next step, run::
+Follow `README.txt`, Quick start (alternatively Using upstream code),
+and as a next step, run::
git update-index --assume-unchanged sunzi/metadata.py
diff --git a/README.txt b/README.txt
index 9eaa6f4..0dc57b7 100644
--- a/README.txt
+++ b/README.txt
@@ -63,7 +63,7 @@ as usual.
2.3 Quick start (for contribution)
----------------------------------
-Bootstrap script is the fastest way to experiment with sunzi. No external
+Bootstrap script is the fastest way to experiment with `sunzi`. No external
Python library is needed as Python side is well-managed in the isolated
virtualenv environment. This snippet will setup the environment in the
current dir (but feel free to modify as per your needs)::
@@ -81,6 +81,10 @@ the virtualenv environment is used automatically, but you have to
activate
it manually (`source bin/activate`, look at virtualenv documentation)
before rerunning the application, etc.
+Note: `yolk`_ allows maintaining packages within the virtualenv environment.
+
+.. _yolk:
http://pypi.python.org/pypi/yolk
+
.. ``TODO``
.. Prerequisities for successful build/installation/deployment: