Skip to content

Commit

Permalink
move developer documentation to its own file
Browse files Browse the repository at this point in the history
  • Loading branch information
afeld committed Oct 20, 2016
1 parent 04c2fef commit 4da571e
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 62 deletions.
62 changes: 1 addition & 61 deletions CONTRIBUTING.md
Expand Up @@ -8,67 +8,7 @@ We encourage you to read this project's CONTRIBUTING policy (you are here), its

If you have any questions or want to read more, check out the [18F Open Source Policy GitHub repository]( https://github.com/18f/open-source-policy), or just [shoot us an email](mailto:18f@gsa.gov).

## Development

This project uses [glide](https://github.com/Masterminds/glide) to manage vendored dependencies.

### Project setup

1. Install Go 1.6+, and ensure your `GOPATH` is set. Using [gvm](https://github.com/moovweb/gvm) is recommended.
1. Install the tool.

```sh
go get github.com/opencontrol/compliance-masonry
compliance-masonry
```

This should print out usage documentation. You can find the code in `$GOPATH/src/github.com/opencontrol/compliance-masonry/`.

### Running tests

```sh
# Get test dependencies
go get -t ./...
# Run tests
go test $(glide nv)
```

### Updating dependencies

Masonry uses [glide](https://github.com/Masterminds/glide) to manage dependencies.

```sh
go get github.com/Masterminds/glide
glide up --all-dependencies
```

### Creating Binaries

#### One Time Setup for Uploading Binaries

1. Install [goxc](go get github.com/laher/goxc)

```sh
go get github.com/laher/goxc
```

1. [Get a GitHub API token](https://github.com/settings/tokens/new). The token should have write access to repos.
1. Add a .goxc.local.json file with a github api key

```sh
goxc -wlc default publish-github -apikey=123456789012
```

#### Compiling and Uploading Binaries

1. Set version number in:
* [`.goxc.json`](.goxc.json)
* As `app.Version` in [`masonry-go.go`](masonry-go.go)
1. Run the release script

```sh
./release.sh
```
See [this page](docs/development.md) for developer documentation.

## Public domain

Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -11,4 +11,4 @@ Compliance Masonry is a command-line interface (CLI) that allows users to constr
* [Overview](docs/)
* [Installation](docs/install.md)
* [Usage](docs/usage.md)
* [Developer documentation](CONTRIBUTING.md#development)
* [Developer setup](docs/development.md)
61 changes: 61 additions & 0 deletions docs/development.md
@@ -0,0 +1,61 @@
# Development

This project uses [glide](https://github.com/Masterminds/glide) to manage vendored dependencies.

## Project setup

1. Install Go 1.6+, and ensure your `GOPATH` is set. Using [gvm](https://github.com/moovweb/gvm) is recommended.
1. Install the tool.

```sh
go get github.com/opencontrol/compliance-masonry
compliance-masonry
```

This should print out usage documentation. You can find the code in `$GOPATH/src/github.com/opencontrol/compliance-masonry/`.

## Running tests

```sh
# Get test dependencies
go get -t ./...
# Run tests
go test $(glide nv)
```

## Updating dependencies

Masonry uses [glide](https://github.com/Masterminds/glide) to manage dependencies.

```sh
go get github.com/Masterminds/glide
glide up --all-dependencies
```

## Creating binaries

### One-time setup for uploading binaries

1. Install [goxc](go get github.com/laher/goxc)

```sh
go get github.com/laher/goxc
```

1. [Get a GitHub API token](https://github.com/settings/tokens/new). The token should have write access to repos.
1. Add a .goxc.local.json file with a github api key

```sh
goxc -wlc default publish-github -apikey=123456789012
```

### Compiling and uploading binaries

1. Set version number in:
* [`.goxc.json`](.goxc.json)
* As `app.Version` in [`masonry-go.go`](masonry-go.go)
1. Run the release script

```sh
./release.sh
```

0 comments on commit 4da571e

Please sign in to comment.