Greg Ward avatar Greg Ward committed e09324f

update README, release process

Comments (0)

Files changed (2)

-vcprompt
-========
+vcprompt: version control information in your prompt
+====================================================
 
-vcprompt is a little C program that prints a short string, to be
-included in your shell prompt, with barebones information about the
-current working directory for various version control systems. It is
-designed to be small and lightweight rather than comprehensive.
+vcprompt is a little C program that prints a short string with
+barebones information about the current working directory for various
+version control systems. You configure your shell to include the
+output of vcprompt in your prompt, and you get version control
+information in your prompt.
 
-Currently, it has varying degrees of recognition for Mercurial, Git,
-Subversion, CVS, and Fossil working copies.
+vcprompt is designed to be small and lightweight rather than
+comprehensive. Currently, it has varying degrees of support for
+Mercurial, Git, Subversion, CVS, and Fossil working copies.
 
 vcprompt has minimal dependencies: it does as much as it can with the
 standard C library and POSIX calls. It should work on any
 Dependencies
 ============
 
-vcprompt always requires GNU make to build.
+vcprompt requires GNU make to build.
 
-vcprompt requires GNU autoconf to build from a source checkout (not
-from a source tarball).
+vcprompt requires GNU autoconf to build from a source checkout (but
+not from a source tarball).
 
 Support for Subversion >= 1.7 requires SQLite 3. If it's not present on
 the build system, vcprompt will support Subversion <= 1.6. Either way,
 
     groff -Tascii -man vcprompt.1 | less
 
-* commit any required changes
+* commit and push any required changes
 
 * clone on at least one different machine and run the tests:
 
     hg clone http://hg.gerg.ca/vcprompt
     cd vcprompt
+    autoconf && ./configure
     make grind      # requires valgrind
     make check      # if valgrind not installed
 
 * select the version number, e.g.:
 
-    ver=1.1
+    ver=x.y.z
 
 * tag the release and build the source tarball
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.