postmodern / repertoire

A Ruby library for quickly checking-out and updating code-bases from various SCMs.

This URL has Read+Write access

commit  54032b0ff23051427544b201dade0110c2d8442d
tree    41319bb152a246be72d3db1476a0f674eb7ba466
parent  04c07e931831179b08fc1c128a1c2c7229b6bf51
repertoire / README.txt
100644 78 lines (53 sloc) 2.27 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
= R'epertoire
 
* http://repertoire.rubyforge.org/
* http://github.com/postmodern/repertoire/
* Postmodern (postmodern.mod3 at gmail.com)
 
== DESCRIPTION:
  
R'epertoire is a Ruby library for quickly checking-out and updating
code-bases from various SCMs. R'epertoire currently supports Subversion,
Git, Mercurial and even RSync.
 
== FEATURES/PROBLEMS:
  
* Currently supports checking-out and updating from:
  * Mercurial (Hg)
  * Git
  * RSync
  * Subversion (SVN)
 
== EXAMPLES:
 
* Checkout a repository using a URI:
 
    Repertoire.checkout(
      :uri => 'svn://rubyforge.org/var/svn/repertoire/trunk',
      :path => 'repertoire'
    )
 
* Checkout a repository of a specific media type:
 
    Repertoire.checkout(
      :uri => 'http://repertoire.rubyforge.org/svn/trunk',
      :media => :svn,
      :path => 'repertoire'
    )
 
* Update a previously checked-out repository:
 
    Repertoire.update(:path => 'repertoire')
 
* Update a previously checked-out repository of a specific media type:
 
    Repertoire.update(:path => 'path/to/rsynced_data', :media => :rsync)
 
== REQUIREMENTS:
 
* {YARD}[http://yard.soen.ca/] >= 0.2.3.5
 
== INSTALL:
 
  $ sudo gem install repertoire
 
== LICENSE:
 
The MIT License
 
Copyright (c) 2008-2009 Hal Brodigan
 
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
 
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.