mercurial-quick-start

From Microformats Wiki
Revision as of 20:46, 18 September 2006 by ScottJungling (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

HowTo: Download code from the repository

I had a little difficulty checking out code from the repository, so I created this page to help those who are new to Mercurial and the Microformats repository.

Introduction

Microformats.org uses Mercurial for source code management. You can find microformat generators, tests, and Brian Suda's X2V scripts in the repository at [1]

Mercurial

Mercurial offers binary packages and source code for Windows, Linux, and Mac OSX. You can read more about how to install Mercurial from their wiki.

Checking out code

Once you have Mercurial installed, the quickest way to get started with the following recipe.

The first time you access a repository, you must first clone the repository on your local drive.

For example: to download the latest code for X2V, you would use the following:

hg clone http://hg.microformats.org/x2v/

Once you have cloned the repository, you can update your local code with the latest from the Microformats repository with:

hg update http://hg.microformats.org/x2v/

Rake

For those of you with Rake installed on your machine you can take advantage of the Rakefile included with the Generators and X2V. The Rakefile makes two commands available:

  1. rake hg:pull_update -- Pull and update this repository. May fail if you need to merge
  2. rake hg:push_update -- Pushes this repository to microformats.org. Pulls and updates first