[Checkins] SVN: van.pydeb/trunk/ Improve README.txt. Thanks to Fabio Tranchitella for a better looking way of

[Brian Sutherland]

Log message for revision 100536:
  Improve README.txt. Thanks to Fabio Tranchitella for a better looking way of
  calling van-pydeb in the rules file.
  

Changed:
  U   van.pydeb/trunk/CHANGES.txt
  U   van.pydeb/trunk/README.txt

-=-
Modified: van.pydeb/trunk/CHANGES.txt
===================================================================
--- van.pydeb/trunk/CHANGES.txt	2009-05-29 15:16:36 UTC (rev 100535)
+++ van.pydeb/trunk/CHANGES.txt	2009-05-29 16:21:19 UTC (rev 100536)
@@ -1,7 +1,11 @@
-1.1.1 (unreleased)
+Changes
+=======
+
+1.2.0 (unreleased)
 ------------------
 
-* ???
+* Improve README.txt. Thanks to Fabio Tranchitella for a better looking way of
+  calling van-pydeb in the rules file.
 
 1.1.0 (2009-05-26)
 ------------------

Modified: van.pydeb/trunk/README.txt
===================================================================
--- van.pydeb/trunk/README.txt	2009-05-29 15:16:36 UTC (rev 100535)
+++ van.pydeb/trunk/README.txt	2009-05-29 16:21:19 UTC (rev 100536)
@@ -1,45 +1,45 @@
-PyDebDep
-========
+Tools for introspecting Python package metadata and translating the resulting
+information into Debian metadata. This information is translated:
 
-Tools for introspecting egg-info directories and translating the resulting
-information into debian format. This information is translated:
+* Setuptools version numbers to Debian format that sorts correctly
+* Setuptools package names to Debian binary and source package names
+* Setuptools dependencies to Debian dependencies
 
-    * Setuptools version numbers to debian format that sorts correctly
-    * Setuptools package names to debian binary and source package names
-    * Setuptools dependencies to debian dependencies
+This package provides a ``van-pydeb`` binary which provides a way to access the
+information from shell scripts. A python based API is also available for python
+programs to use.
 
-This package provides a script ``van-pydeb`` which introspects an installed
-.egg-info to extract egg dependency information. The package names are
-converted to their debian equivilant and the dependency information is printed
-in the format of a dpkg "Depends:" line.
-
 Usage
------
+=====
 
-To extract the dependency info of this package, one can::
+To extract the dependency info of this package, one can run the following
+command after setting up buildout::
 
-    $ python2.4 setup.py build
-    $ PYTHONPATH=./src python2.4 van-pydeb --depends --egg_info src/vanguardistas.van-pydeb.egg-info
-    python-setuptools, python-vanguardistas
+    $ ./bin/van-pydeb depends --egg-info van.pydeb.egg-info
+    python-setuptools, python-van
 
-This information can then used in a debian/rules file as follows:
+This information can then used in a debian/rules file as follows::
 
-    i="$$(van-pydeb depends --egg-info debian/$(PACKAGE)/usr/lib/python$*/site-packages/$(EGG_NAME).egg-info)" && echo "setuptools:Depends=$$i" >> debian/$(PACKAGE).substvars
+    (echo -n 'setuptools:Depends=' && van-pydeb depends --egg-info debian/$(PACKAGE)/usr/lib/python$*/site-packages/$(EGG_NAME).egg-info) >> debian/$(PACKAGE).substvars
 
-The different methods of using this are:
+There ary many different methods of using this command, such as getting the
+dependencies (including the extra dependencies) of the package::
 
-Give the dependencies (including the extra dependencies) of the package:
-
     van-pydeb depends --egg-info debian/$(PACKAGE)/usr/lip/python$*/$(EGG_NAME).egg-info
 
-The dependencies of an extra:
+Or, the dependencies of an extra::
 
     van-pydeb depends --egg-info debian/$(PACKAGE)/usr/lip/python$*/$(EGG_NAME).egg-info --extra $(EXTRA)
 
-The dependencies of 2 extras:
+The dependencies of 2 extras::
     
     van-pydeb depends --egg-info debian/$(PACKAGE)/usr/lip/python$*/$(EGG_NAME).egg-info --extra $(EXTRA) --extra $(EXTRA2)
 
-The dependencies of a package excluding the dependencies of extras:
+The dependencies of a package excluding the dependencies of extras::
 
     van-pydeb depends --egg-info debian/$(PACKAGE)/usr/lip/python$*/$(EGG_NAME).egg-info --exclude-extra $(EXTRA1) --exclude-extra $(EXTRA2)
+
+Development
+===========
+
+The code for van.pydeb is housed in subversion at http://svn.zope.org/van.pydeb/.