Permalink
Browse files

readme

  • Loading branch information...
1 parent 2b1b1db commit fa82735c1458ded11b427a46f9cfea51578d0aab @timbertson committed Jan 2, 2011
Showing with 80 additions and 15 deletions.
  1. +32 −0 README.md
  2. +48 −15 version.xml
View
@@ -0,0 +1,32 @@
+version parses common files to find and change
+the current version number of your project.
+
+Supported file names are:
+
+ - VERSION (obviously)
+ - setup.py (python setuptools)
+ - conf.py (sphinx configuration)
+
+.. but new file formats can be added fairly easily when required.
+
+# Usage:
+
+ version
+
+To print out your current version number(s) (one line per file).
+
+ version \<number\>
+
+To set the version number across all supported files.
+
+ version +
+
+To increment the minor version number (e.g 0.1.2 -> 0.1.3)
+and save the results to every supported file.
+
+ version ++
+
+To increment the second-most minor version number
+(e.g 0.1.2 -> 0.2.0)
+
+.. and so on for more plusses, for as many as you require.
View
@@ -1,23 +1,56 @@
<?xml version="1.0" ?>
<?xml-stylesheet type='text/xsl' href='interface.xsl'?>
<interface uri="http://gfxmonk.net/dist/0install/version.xml" xmlns="http://zero-install.sourceforge.net/2004/injector/interface">
- <name>version</name>
- <summary>view (and modify) your project version in multiple commonly-used places</summary>
- <description>
- </description>
+ <name>version</name>
+ <summary>view (and modify) your project version in multiple commonly-used places</summary>
+ <publish mode="featured" xmlns="http://gfxmonk.net/dist/0install"/>
+ <description>
+version parses common files to find and change
+the current version number of your project.
+
+Supported file names are:
+
+ - VERSION (obviously)
+ - setup.py (python setuptools)
+ - conf.py (sphinx configuration)
+
+.. but new file formats can be added fairly easily when required.
+
+# Usage:
+
+ version
+
+To print out your current version number(s) (one line per file).
+
+ version \&lt;number\&gt;
+
+To set the version number across all supported files.
+
+ version +
+
+To increment the minor version number (e.g 0.1.2 -&gt; 0.1.3)
+and save the results to every supported file.
+
+ version ++
+
+To increment the second-most minor version number
+(e.g 0.1.2 -&gt; 0.2.0)
+
+.. and so on for more plusses, for as many as you require.
+ </description>
<homepage>http://github.com/gfxmonk/version</homepage>
- <group main="version.py">
+ <group main="version.py">
<implementation id="sha1new=bea229b667512d5b01b6b7f35919ca88ee95af50" released="2010-07-31" version="0.2">
- <manifest-digest sha256="193941f6f9f61c35ea94156cfd1c8e52e25577ce3e23f89db0eead9120154a65"/>
- <archive href="http://gfxmonk.net/dist/0install/version/version-0.2.tgz" size="1551"/>
- </implementation>
+ <manifest-digest sha256="193941f6f9f61c35ea94156cfd1c8e52e25577ce3e23f89db0eead9120154a65"/>
+ <archive href="http://gfxmonk.net/dist/0install/version/version-0.2.tgz" size="1551"/>
+ </implementation>
<implementation id="sha1new=914352d2bf3420c6135ead0deedf4a2c47e9f3d4" released="2010-10-04" version="0.3">
- <manifest-digest sha256="c5dfc96c8e5c8728e9a405f6dea26117cba748e8bf3c0f20db284ae6e39f406e"/>
- <archive href="http://gfxmonk.net/dist/0install/version/version-0.3.tgz" size="1599"/>
- </implementation>
+ <manifest-digest sha256="c5dfc96c8e5c8728e9a405f6dea26117cba748e8bf3c0f20db284ae6e39f406e"/>
+ <archive href="http://gfxmonk.net/dist/0install/version/version-0.3.tgz" size="1599"/>
+ </implementation>
<implementation id="sha1new=9e2b15e43955d5efeb265b70c53914397a42e8d0" released="2010-12-29" version="0.4">
- <manifest-digest sha256="9576e33d62a121cafc972d1ef64fe74c2e4c38fd14ebadc077cb39973bdcfeed"/>
- <archive href="http://gfxmonk.net/dist/0install/version/version-0.4.tgz" size="1657"/>
- </implementation>
- </group>
+ <manifest-digest sha256="9576e33d62a121cafc972d1ef64fe74c2e4c38fd14ebadc077cb39973bdcfeed"/>
+ <archive href="http://gfxmonk.net/dist/0install/version/version-0.4.tgz" size="1657"/>
+ </implementation>
+ </group>
</interface>

0 comments on commit fa82735

Please sign in to comment.