README.markdown @ 16aa2def1d5b default tip

Update to work with Python 3

The Hamster Wheel of Backwards Incompatibility turns ever onward.  This probably
breaks support for Python 2, but at this point I don't care.  I just can't
summon up the willpower to do anything more than the most basic unfucking of
this thing that's been finished for 11 years but still breaks constantly because
of Mercurial's API churn and Python 3 setting the world on fire.

                                                                                    The
_  _ ____ _  _ ____ ___ ____ ____    _ _ _ _  _ ____ ____ _       ____ ____    ___  ____ ____ _  _ _ _ _ ____ ____ ___  ____    _ _  _ ____ ____ _  _ ___  ____ ___ _ ___  _ _    _ ___ _   _
|__| |__| |\/| [__   |  |___ |__/    | | | |__| |___ |___ |       |  | |___    |__] |__| |    |_/  | | | |__| |__/ |  \ [__     | |\ | |    |  | |\/| |__] |__|  |  | |__] | |    |  |   \_/
|  | |  | |  | ___]  |  |___ |  \    |_|_| |  | |___ |___ |___    |__| |       |__] |  | |___ | \_ |_|_| |  | |  \ |__/ ___]    | | \| |___ |__| |  | |    |  |  |  | |__] | |___ |  |    |
                                                                                turns forever
author Steve Losh <steve@stevelosh.com>
date Tue, 06 Apr 2021 12:55:48 -0400
parents 9f0b70dfcf52
children (none)
hg-prompt
=========

hg-prompt adds an 'hg prompt' command to Mercurial for viewing repository information.  It's designed to be used in a shell prompt.


Requirements
------------

hg-prompt requires Python 2.5+ and (obviously) Mercurial.


Installing
----------

Clone the repository:

    $ hg clone http://bitbucket.org/sjl/hg-prompt/

Edit the `[extensions]` section in your `~/.hgrc` file:

    [extensions]
    prompt = (path to)/hg-prompt/prompt.py


Documentation
-------------

The documentation for hg-prompt is at the [project page][project].  There's a [Quick Start guide][quickstart], [Full Usage Guide][usage], [Keyword List][keywords], and a few other things there.

The documentation is stored in the `docs/` directory of the repository if you prefer to read it offline.

[project]: http://sjl.bitbucket.org/hg-prompt/
[quickstart]: http://sjl.bitbucket.org/hg-prompt/quickstart/
[usage]: http://sjl.bitbucket.org/hg-prompt/documentation/usage/
[keywords]: http://sjl.bitbucket.org/hg-prompt/documentation/keywords/


Questions, Comments, Suggestions
--------------------------------

The code was kind of thrown together in a few nights after I got tired of chaining three or four hg runs together to get what I wanted.  I'm sure it's not perfect, so if you've got a way to improve it please add an issue and let me know.

Patches are also welcome!