Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100755 30 lines (19 sloc) 0.874 kB
30be98f @chad gemspec and readme
authored
1 Hopefully-meaningful Metrics
2 ============================
3
2ccfa7e @seeflanigan Minor formatting change to usage command
seeflanigan authored
4 Based on Michael Feathers' [recent work](http://www.stickyminds.com/sitewide.asp?Function=edetail&ObjectType=COL&ObjectId=16679&tth=DYN&tt=siteemail&iDyn=2) in project churn and complexity.
30be98f @chad gemspec and readme
authored
5
70e45bd @seeflanigan Add gem installation instructions
seeflanigan authored
6 Installation
7 ------------
8
9 $ gem install turbulence
10
30be98f @chad gemspec and readme
authored
11 Usage
12 -----
2ccfa7e @seeflanigan Minor formatting change to usage command
seeflanigan authored
13 In your project directory, run:
30be98f @chad gemspec and readme
authored
14
2ccfa7e @seeflanigan Minor formatting change to usage command
seeflanigan authored
15 $ bule
30be98f @chad gemspec and readme
authored
16
b09a3e3 @jhwist Added instructions for Perforce usage
jhwist authored
17 and it will generate (and open) turbulence/turbulence.html
18
19 Supported SCM systems
20 ---------------------
21 Currently, bule defaults to using git. If you are using Perforce, call it like so:
22
23 $ bule --scm p4
24
25 You need to have an environment variable P4CLIENT set to the name of your client workspace.
e1fe436 @chad warning in readme
authored
26
27 WARNING
28 -------
29 When you run bule, it creates a JavaScript file which contains your file paths and names. If those are sensitive, be careful where you put these generated files and who you share them with.
Something went wrong with that request. Please try again.