From f4ac9b701048becdb749af2ae3fe117ce638f53e Mon Sep 17 00:00:00 2001 From: Ronny Pfannschmidt Date: Tue, 14 Sep 2010 23:52:07 +0200 Subject: document the usage as setup requirement --- README.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.txt b/README.txt index 4c58eb9..954da2f 100644 --- a/README.txt +++ b/README.txt @@ -4,6 +4,8 @@ hgdistver This module is a simple drop-in to support setup.py in mercurial based projects. +Alternatively it can be a setup time requirement. + Its supposed to generate version numbers from mercurials meta-data. It tries to use the current tag and falls back to the next reachable tagged ancestor and @@ -29,3 +31,16 @@ The most simple usage is:: `get_version` takes the optional argument `cachefile`, which causes it to store the version info in a python script instead of abusing PKG-INFO from a sdist. + + +The setup requirement usage is:: + + from setuptools import setup + setup( + ..., + get_version_from_hg=True, + setup_requires=['hgdistver'], + ..., + ) + +The requirement usage doesn't yet support cachefile. -- cgit v1.2.1