comparison contrib/win32/ReadMe.html @ 1288:9a625fbfa220

Turn the win32 README into a HTML file for now.
author Bryan O'Sullivan <bos@serpentine.com>
date Wed, 21 Sep 2005 00:20:20 -0700
parents contrib/win32/README.txt@40ccb87dac71
children 58894621c87a
comparison
equal deleted inserted replaced
1287:40ccb87dac71 1288:9a625fbfa220
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <title>Mercurial for Windows</title>
5 </head>
6
7 <body>
8 <h1>Mercurial version 0.7 for Windows</h1>
9
10 <p>Welcome to Mercurial for Windows!</p>
11
12 <p>Mercurial is a command-line application. You must run it from
13 the Windows command prompt (or if you're hard core, a <a
14 href="http://www.mingw.org/">MinGW</a> shell).</p>
15
16 <p>For documentation, please visit the <a
17 href="http://www.selenic.com/mercurial">Mercurial web
18 site</a>.</p>
19
20 <p>By default, Mercurial installs to <tt>C:\Mercurial</tt>. The
21 Mercurial command is called <tt>hg.exe</tt>. To run this
22 command, the install directory must be in your search path.</p>
23
24 <h2>Setting your search path temporarily</h2>
25
26 <p>To set your search path temporarily, type the following into a
27 command prompt window:</p>
28
29 <pre>
30 set PATH=C:\Mercurial;%PATH%
31 </pre>
32
33 <h2>Setting your search path permanently</h2>
34
35 <p>To set your search path permanently, perform the following
36 steps. These instructions are for Windows NT, 2000 and XP.</p>
37
38 <ol>
39 <li>Open the Control Panel. Under Windows XP, select the
40 "Classic View".</li>
41
42 <li>Double-click on the "System" control panel.</li>
43
44 <li>Click on the "Advanced" tab.</li>
45
46 <li>Click on "Environment Variables". You'll find this near the
47 bottom of the window.</li>
48
49 <li>Under "System variables", you will see "Path". Double-click
50 it.</li>
51
52 <li>Edit "Variable value". Each path element is separated by a
53 semicolon (";") character. Append a semicolon to the end of the
54 list, followed by the path where you installed Mercurial
55 (e.g. <tt>C:\Mercurial</tt>).</li>
56
57 <li>Click on the various "OK" buttons until you've completely
58 exited from the System control panel.</li>
59
60 <li>Log out and log back in, or restart your system.</li>
61
62 <li>The next time you run the Windows command prompt, you will be
63 able to run the <tt>hg</tt> command without any special
64 help.</li>
65 </ol>
66
67 <h1>Testing Mercurial after you've installed it</h1>
68
69 <p>The easiest way to check that Mercurial is installed properly is to
70 just type the following at the command prompt:</p>
71
72 <pre>
73 hg
74 </pre>
75
76 <p>This command should print a useful help message. If it does,
77 other Mercurial commands should work fine for you.</p>
78
79 <h1>Reporting problems</h1>
80
81 <p>Before you report any problems, please consult the <a
82 href="http://www.selenic.com/mercurial">Mercurial web site</a> and
83 see if your question is already in our list of <a
84 href="http://www.selenic.com/mercurial/wiki/index.cgi/FAQ">Frequently
85 Answered Questions</a> (the "FAQ").
86
87 <p>If you cannot find an answer to your question, please feel
88 free to send mail to the Mercurial mailing list, at <a
89 href="mailto:mercurial@selenic.com">mercurial@selenic.com</a>.
90 <b>Remember</b>, the more useful information you include in your
91 report, the easier it will be for us to help you!</p>
92
93 <p>If you are IRC-savvy, that's usually the fastest way to get
94 help. Go to <tt>#mercurial</tt> on
95 <tt>irc.freenode.net</tt>.</p>
96
97 <h1>Author and copyright information</h1>
98
99 <p>Mercurial was written by <a href="http://www.selenic.com">Matt
100 Mackall</a>, and is maintained by Matt and a team of
101 volunteers.</p>
102
103 <p>The Windows installer was written by <a
104 href="http://www.serpentine.com/blog">Bryan
105 O'Sullivan</a>.</p>
106
107 <p>Mercurial is Copyright 2005 Matt Mackall and others. See the
108 <tt>Contributors.txt</tt> file for a list of contributors.</p>
109
110 <p>Mercurial is free software; you can redistribute it and/or
111 modify it under the terms of the <a
112 href="http://www.gnu.org/copyleft/gpl.html">GNU General Public
113 License</a> as published by the Free Software Foundation; either
114 version 2 of the License, or (at your option) any later
115 version.</p>
116
117 <p>Mercurial is distributed in the hope that it will be useful,
118 but <b>without any warranty</b>; without even the implied
119 warranty of <b>merchantability</b> or <b>fitness for a
120 particular purpose</b>. See the GNU General Public License for
121 more details.</p>
122 </body>
123 </html>