HelpHgIntro » History » Version 4

Luis Figueira, 2011-03-16 02:14 PM
link to installation page

1 3 Luis Figueira
h1. An Introduction to Mercurial using EasyMercurial (easyHg)
2 1 Luis Figueira
3 3 Luis Figueira
Mercurial is a distributed revision control tool. It is written in Python. 
4 1 Luis Figueira
5 1 Luis Figueira
6 3 Luis Figueira
h2. Installation
7 1 Luis Figueira
8 4 Luis Figueira
See [[InstallingEasyHg|Installing Easy Mercurial]]
9 3 Luis Figueira
10 3 Luis Figueira
11 3 Luis Figueira
h3. Running for the first time
12 3 Luis Figueira
13 3 Luis Figueira
When you run easyHg for the first time you'll be prompted for a _username_ and _email address_. These are the details that will be used to identify all your changes pushed to the repositories. They can be changed later in the preferences menu.
14 3 Luis Figueira
15 3 Luis Figueira
h2. The User Interface
16 3 Luis Figueira
17 3 Luis Figueira
EasyMercurial is an interface for Mercurial, simplifying its usage and making it usable by common users. 
18 3 Luis Figueira
19 3 Luis Figueira
h3. My Work Tab
20 3 Luis Figueira
21 3 Luis Figueira
22 3 Luis Figueira
h3. History Tab
23 3 Luis Figueira
24 3 Luis Figueira
Graph of changes. The user can right click on any version and act on it (update to it, revert, )
25 3 Luis Figueira
26 3 Luis Figueira
h3. Available Commands
27 3 Luis Figueira
28 3 Luis Figueira
These are the commands you'll find in the easyMercurial interface:
29 3 Luis Figueira
30 1 Luis Figueira
*add*          add the specified files on the next commit
31 1 Luis Figueira
*commit*       commit the specified files or all outstanding changes
32 1 Luis Figueira
*diff*         diff repository (or selected files)
33 1 Luis Figueira
*incoming*     show new changesets found in source (in the easyMercurial interface this command is called Preview)
34 1 Luis Figueira
*merge*        merge working directory with another revision
35 1 Luis Figueira
*pull*         pull changes from the specified source
36 2 Luis Figueira
*push*         push changes to the specified destination
37 1 Luis Figueira
*revert*       restore individual files or directories to an earlier state
38 2 Luis Figueira
*update*       update working directory (or switch revisions)
39 1 Luis Figueira
40 2 Luis Figueira
41 2 Luis Figueira
h2. Typical Workflow
42 2 Luis Figueira
43 2 Luis Figueira
h3. Creating or Opening a Repository
44 2 Luis Figueira
45 2 Luis Figueira
h4. Local Repository
46 2 Luis Figueira
47 2 Luis Figueira
Allows you to open a local repository.
48 2 Luis Figueira
49 2 Luis Figueira
h4. File Folder
50 2 Luis Figueira
51 2 Luis Figueira
Allows you to initialize a local folder as a Mercurial repository.
52 2 Luis Figueira
53 1 Luis Figueira
h4. External Repository
54 1 Luis Figueira
55 2 Luis Figueira
If you have a remote repository URL and want to clone (make a copy of an existing repository) it to your local filesystem. 
56 1 Luis Figueira
57 2 Luis Figueira
Workflow
58 1 Luis Figueira
59 3 Luis Figueira
Updating local repository from remote: 
60 2 Luis Figueira
61 3 Luis Figueira
# pull
62 3 Luis Figueira
# update
63 2 Luis Figueira
64 3 Luis Figueira
Updating remote repository from local: 
65 1 Luis Figueira
66 3 Luis Figueira
# commit
67 3 Luis Figueira
# push
68 2 Luis Figueira
69 3 Luis Figueira
A window will pop-up asking you to write a message to describe your changes. This message is *very important* because it will tell you and the other developers in the project the reason why you are pushing the changes to the repository.
70 2 Luis Figueira
71 2 Luis Figueira
72 1 Luis Figueira
h3. External resources
73 1 Luis Figueira
74 2 Luis Figueira
* For a simple tutorial on Mercurial (command line), please go to http://hginit.com/
75 2 Luis Figueira
* _Mercurial: The Definitive Guide_ by Bryan O'Sullivan is a reference book on Mercurial. You can read it for free here: http://hgbook.red-bean.com/
76 3 Luis Figueira
* Simple and starightforward mercurial tutorial http://wiki.alliedmods.net/Mercurial_Tutorial