#pair#

Copyright (c) 2012 Andrzej Śliwa.

Version: 0.1

pair is a simple git helper for pair programming

Note: This is a work in progress, see the TODO for more informations on what still need to be done.

License

See LICENSE file for licensing information.

Installation

Download the sources from our Github repository

Build it

$ cd pair
$ make

Copy 'pair' to your bin path (ex. /usr/local/bin)

$ cp pair ~/usr/local/bin

Basic usage

The basic usage of pair is:Run it first time

$ pair
created example pair config: '/Users/andrzejsliwa/.pair.config'
first update it and run pair again...

Edit config file (~/.pair.config)

%% define your identity...
{my_name,  "Andrzej Sliwa"}.
{my_email, "andrzej.sliwa@i-tool.eu"}.

%% define your pairs...
{"an-ar",  [{left, my_name}, {right, "Artur Kowalski"},
{email, "andrzej+artur@mydomain.com"}]}.
{"an-jan", [{left, my_name}, {right, "Jan Kowalski"},
{email, "andrzej+jan@mydomain.com"}]}.

Change pair

$ ./pair an-ar
Pairing: Andrzej Sliwa + Artur Kowalski

then your .git/config looks like

[user]
name = Andrzej Sliwa + Artur Kowalski
email = andrzej+artur@mydomain.com

Back to your identity

$ ./pair
Back to my identity.

and then your .git/config looks like

[user]
name = Andrzej Sliwa
email = andrzej.sliwa@i-tool.eu

To generate doc, run 'make doc'.

Contribute

For issues, comments or feedback please create an issue.

Notes for developers

If you want to contribute patches or improve the doc, you will need to build hackney using the rebar.dev.config file. It can also be built using the Makefile:

$ make dev       ; # compile & get deps
$ make dev_clean ; # clean all files

##Modules##

pair