hg-prompt/installation.html @ b698f1159c04

Add the hg-prompt docs.
author Steve Losh <steve@stevelosh.com>
date Wed, 18 Nov 2009 20:48:00 -0500
parents (none)
children d72a55aed48f
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
  <head>
    <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
    
    <title>
      hg-prompt ยป Installation
    </title>
    
    <link rel="stylesheet" type="text/css" href="/media/css/reset.css" media="screen, projection" />
    <link rel="stylesheet" type="text/css" href="/media/css/layout.css" media="screen, projection" />
    <link rel="stylesheet" type="text/css" href="/media/css/typography.css" media="screen, projection" />
    <link rel="stylesheet" type="text/css" href="/media/css/pygments.css" media="screen, projection" />
  </head>
  
  <body>
    <div id="content">

      
        <div id="breadcrumbs">
          <p>
              
                
                  <a href="/">index</a> &#187;
                
              
                
                  installation
                
              
          </p>
        </div> <!-- div#breadcrumbs -->
      
      
      
  <h1 id="installation">Installation</h1>
<p>Installing <code>hg-prompt</code> requires <a href="http://python.org/">Python</a> 2.5+ and (obviously) Mercurial.</p>
<p>First, clone the repository:</p>
<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">hg</span> <span class="n">clone</span> <span class="n">http:</span><span class="sr">//</span><span class="n">bitbucket</span><span class="o">.</span><span class="n">org</span><span class="sr">/sjl/</span><span class="n">hg</span><span class="o">-</span><span class="n">prompt</span><span class="o">/</span>
</pre></div>


<p>Edit the <code>[extensions]</code> section in your <code>~/.hgrc</code> file:</p>
<div class="codehilite"><pre><span class="k">[extensions]</span>
<span class="na">prompt</span> <span class="o">=</span> <span class="s">(path to)/hg-prompt/prompt.py</span>
</pre></div>


<p>Make sure everything is working:</p>
<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">hg</span> <span class="n">prompt</span> <span class="s">&#39;test&#39;</span>
<span class="n">test</span>
</pre></div>


<p>Take a look at the <a href="/quickstart/">Quick Start</a> guide to learn how to put some useful information into your shell prompt.</p>

    
      <p id="footer">
        
          hg-prompt &mdash;
        
        Powered by <a href="http://bitbucket.org/zacharyvoase/markdoc">Markdoc</a>.
      </p>
    
    </div> <!-- div#content -->
  </body>
</html>