hg-prompt/installation/index.html @ 08c786bf864c

hg-review: Update documentation.
author Steve Losh <steve@stevelosh.com>
date Mon, 14 Jun 2010 23:35:03 -0400
parents c63538ce40e1
children abcf6f68470c
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN"
    "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
      xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
      xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
      xmlns:dc="http://purl.org/dc/elements/1.1/"
      xmlns:foaf="http://xmlns.com/foaf/0.1/">
  
  <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="gp">$</span> hg clone http://bitbucket.org/sjl/hg-prompt/
</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)/prompt.py</span>
</pre></div>


<p>Make sure everything is working:</p>
<div class="codehilite"><pre><span class="gp">$</span> hg prompt <span class="s1">&#39;test&#39;</span>
<span class="go">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 —
        
        Powered by <a href="http://bitbucket.org/zacharyvoase/markdoc">Markdoc</a>.
      </p>
    
    </div> <!-- div#content -->
  </body>
</html>