contrib/win32/README.txt
author Bryan O'Sullivan <bos@serpentine.com>
Wed, 21 Sep 2005 00:02:53 -0700
changeset 1287 40ccb87dac71
permissions -rw-r--r--
Add win32 README for standalone installer.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     1
Mercurial version 0.7 for Windows
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     2
---------------------------------
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     3
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     4
Welcome to Mercurial for Windows!
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     5
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     6
Mercurial is a command-line application.  You must run it from the
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     7
Windows command prompt (or if you're hard core, a MinGW shell).
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     8
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     9
By default, Mercurial installs to C:\Mercurial.  The Mercurial command
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    10
is called hg.exe.  To run this command, the install directory must be
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    11
in your search path.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    12
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    13
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    14
Setting your search path temporarily
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    15
------------------------------------
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    16
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    17
To set your search path temporarily, type the following into a command
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    18
prompt window:
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    19
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    20
set PATH=C:\Mercurial;%PATH%
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    21
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    22
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    23
Setting your search path permanently
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    24
------------------------------------
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    25
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    26
To set your search path permanently, perform the following steps.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    27
These instructions are for Windows NT, 2000 and XP.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    28
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    29
1. Open the Control Panel.  Under Windows XP, select the "Classic
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    30
   View".
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    31
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    32
2. Enter the "System" control panel.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    33
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    34
3. Click on "Advanced".
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    35
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    36
4. Click on "Environment Variables".
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    37
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    38
5. Under "System variables", you will see "Path".  Double-click it.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    39
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    40
6. Edit "Variable value".  Each path element is separated by a
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    41
   semicolon (";") character.  Append a semicolon to the end of the
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    42
   list, followed by the path where you installed Mercurial
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    43
   (e.g. C:\Mercurial).
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    44
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    45
7. Click on the various "OK" buttons until you're back up to the top
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    46
   level.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    47
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    48
8. Log out and log back in, or restart your system.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    49
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    50
9. The next time you run the Windows command prompt, you will be able
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    51
   to run hg.exe.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    52
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    53
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    54
Testing Mercurial
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    55
-----------------
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    56
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    57
The easiest way to check that Mercurial is installed properly is to
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    58
just type the following at the command prompt:
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    59
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    60
hg
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    61
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    62
It should print a help message.  If it does, it should work fine for
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    63
you.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    64
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    65
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    66
Reporting problems
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    67
------------------
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    68
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    69
Before you report any problems, please consult the Mercurial web site
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    70
at http://www.selenic.com/mercurial and see if your question is
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    71
already in our list of Frequently Answered Questions (the "FAQ").
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    72
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    73
If you cannot find an answer to your question, please feel free to
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    74
send mail to the Mercurial mailing list, at <mercurial@selenic.com>.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    75
Remember, the more useful information you include in your report, the
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    76
easier it will be for us to help you!
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    77
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    78
If you are IRC-savvy, that's usually the fastest way to get help.  Go
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    79
to #mercurial on irc.freenode.net.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    80
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    81
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    82
Author and copyright information
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    83
--------------------------------
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    84
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    85
Mercurial was written by Matt Mackall, and is maintained by Matt and a
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    86
team of volunteers.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    87
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    88
The Windows installer was written by Bryan O'Sullivan.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    89
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    90
Copyright 2005 Matt Mackall and others.  See the CONTRIBUTORS.txt file
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    91
for a list of contributors.
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    92
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    93
Mercurial is free software, released under the terms of the GNU
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    94
General Public License, version 2.