HACKING.markdown


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Hacking HCl

## Running the tests

Use Bundler to install dependencies before you run the tests:

    gem install bundler
    bundle
    rake test

## Running HCl during development

To run HCl in place (e.g. for testing out local changes) you can use bundle exec:

    bundle exec bin/hcl

## Generating API documentation

To generate and view the API documentation:

    rake doc
    open doc/index.html