Skip to content

Commit

Permalink
Add development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sds committed Oct 31, 2016
1 parent 25f8a2b commit 8972688
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ environments inside [Docker](https://www.docker.com/) containers.
* [Configuration](#configuration)
* [Options](#options)
* [Helpers](#helpers)
* [Development](#development)
* [Running Tests](#running-tests)
* [License](#license)

## Installation
Expand Down Expand Up @@ -566,6 +568,29 @@ Directory in the container that the repository will be mounted at.

Outputs the absolute path.

## Development

Hacking on Dock is easy thanks to the fact that it is run within a Dock
container! Provided you have Docker and Bash installed on your system, working
on Dock is as easy as running `bin/dock` from the root of the repository.

### Running Tests

Tests can be run by executing:

```bash
bin/test
```

...from the root of the repository. This will start a Dock container and run
all tests, which are written in Bash using [Bats](https://github.com/sstephenson/bats).

To run a specific test or set of tests, execute:

```bash
bin/test test/path/to/test.bats test/path/to/another.bats
```

## License

Dock is released under the [MIT license](LICENSE.md).

0 comments on commit 8972688

Please sign in to comment.