sys/src/cmd/hg/contrib/win32/ReadMe.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3   <head>
   4     <title>Mercurial for Windows</title>
   5     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
   6     <style type="text/css">
   7       <!--
   8       html {
   9         font-family: sans-serif;
  10         margin: 1em 2em;
  11       }
  12
  13       p {
  14         margin-top: 0.5em;
  15         margin-bottom: 0.5em;
  16       }
  17
  18       pre {
  19         margin: 0.25em 0em;
  20         padding: 0.5em;
  21         background-color: #EEE;
  22         border: thin solid #CCC;
  23       }
  24
  25       .indented {
  26         padding-left: 10pt;
  27       }
  28       -->
  29     </style>
  30   </head>
  31
  32   <body>
  33     <h1>Mercurial for Windows</h1>
  34
  35     <p>Welcome to Mercurial for Windows!</p>
  36
  37     <p>
  38       Mercurial is a command-line application. You must run it from
  39       the Windows command prompt (or if you're hard core, a <a
  40       href="http://www.mingw.org/">MinGW</a> shell).
  41     </p>
  42
  43     <p class="indented">
  44       <i>Note: the standard <a href="http://www.mingw.org/">MinGW</a>
  45       msys startup script uses rxvt which has problems setting up
  46       standard input and output. Running bash directly works
  47       correctly.</i>
  48     </p>
  49
  50     <p>
  51       For documentation, please visit the <a
  52       href="http://mercurial.selenic.com/">Mercurial web site</a>.
  53       You can also download a free book, <a
  54       href="http://hgbook.red-bean.com/">Mercurial: The Definitive
  55       Guide</a>.
  56     </p>
  57
  58     <p>
  59       By default, Mercurial installs to <tt>C:\Program
  60       Files\Mercurial</tt>. The Mercurial command is called
  61       <tt>hg.exe</tt>.
  62     </p>
  63
  64     <h1>Testing Mercurial after you've installed it</h1>
  65
  66     <p>
  67       The easiest way to check that Mercurial is installed properly is
  68       to just type the following at the command prompt:
  69     </p>
  70
  71     <pre>
  72 hg
  73 </pre>
  74
  75     <p>
  76       This command should print a useful help message. If it does,
  77       other Mercurial commands should work fine for you.
  78     </p>
  79
  80     <h1>Configuration notes</h1>
  81     <h4>Default editor</h4>
  82     <p>
  83       The default editor for commit messages is 'notepad'. You can set
  84       the <tt>EDITOR</tt> (or <tt>HGEDITOR</tt>) environment variable
  85       to specify your preference or set it in <tt>mercurial.ini</tt>:
  86     </p>
  87     <pre>
  88 [ui]
  89 editor = whatever
  90 </pre>
  91
  92     <h4>Configuring a Merge program</h4>
  93     <p>
  94       It should be emphasized that Mercurial by itself doesn't attempt
  95       to do a Merge at the file level, neither does it make any
  96       attempt to Resolve the conflicts.
  97     </p>
  98
  99     <p>
 100       By default, Mercurial will use the merge program defined by the
 101       <tt>HGMERGE</tt> environment variable, or uses the one defined
 102       in the <tt>mercurial.ini</tt> file. (see <a
 103       href="http://mercurial.selenic.com/wiki/MergeProgram">MergeProgram</a>
 104       on the Mercurial Wiki for more information)
 105     </p>
 106
 107     <h1>Reporting problems</h1>
 108
 109     <p>
 110       Before you report any problems, please consult the <a
 111       href="http://mercurial.selenic.com/">Mercurial web site</a>
 112       and see if your question is already in our list of <a
 113       href="http://mercurial.selenic.com/wiki/FAQ">Frequently
 114       Answered Questions</a> (the "FAQ").
 115     </p>
 116
 117     <p>
 118       If you cannot find an answer to your question, please feel free
 119       to send mail to the Mercurial mailing list, at <a
 120       href="mailto:mercurial@selenic.com">mercurial@selenic.com</a>.
 121       <b>Remember</b>, the more useful information you include in your
 122       report, the easier it will be for us to help you!
 123     </p>
 124
 125     <p>
 126       If you are IRC-savvy, that's usually the fastest way to get
 127       help. Go to <tt>#mercurial</tt> on <tt>irc.freenode.net</tt>.
 128     </p>
 129
 130     <h1>Author and copyright information</h1>
 131
 132     <p>
 133       Mercurial was written by <a href="http://www.selenic.com">Matt
 134       Mackall</a>, and is maintained by Matt and a team of volunteers.
 135     </p>
 136
 137     <p>
 138       The Windows installer was written by <a
 139       href="http://www.serpentine.com/blog">Bryan O'Sullivan</a>.
 140     </p>
 141
 142     <p>
 143       Mercurial is Copyright 2005-2009 Matt Mackall and others. See
 144       the <tt>Contributors.txt</tt> file for a list of contributors.
 145     </p>
 146
 147     <p>
 148       Mercurial is free software; you can redistribute it and/or
 149       modify it under the terms of the <a
 150       href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">GNU
 151       General Public License version 2</a> as published by the Free
 152       Software Foundation.
 153     </p>
 154
 155     <p>
 156       Mercurial is distributed in the hope that it will be useful, but
 157       <b>without any warranty</b>; without even the implied warranty
 158       of <b>merchantability</b> or <b>fitness for a particular
 159       purpose</b>. See the GNU General Public License for more
 160       details.
 161     </p>
 162   </body>
 163 </html>