Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
*~
*.swp
*.swo
vendor/*/
_test/test
_test/echo_server
_test/tmp
4 changes: 3 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ matrix:
allow_failures:
- go: tip

install:
install:
- go get -u github.com/kardianos/govendor
- govendor sync

script: if [ -z "$FIX_TEST" ]; then make generate && make build && make; else make build_accept && make $FIX_TEST; fi
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ All documentation is available on [GoDoc](https://godoc.org/github.com/quickfixg

To install QuickFIX/Go, use `go get`:

```
go get github.com/quickfixgo/quickfix
```sh
$ go get github.com/quickfixgo/quickfix
```

### Staying up to date
Expand All @@ -42,15 +42,33 @@ If you wish to work on QuickFIX/Go itself, you will first need [Go](http://www.g

For local dev first make sure Go is properly installed, including setting up a [GOPATH](http://golang.org/doc/code.html#GOPATH).

Next, using [Git](https://git-scm.com/), clone this repository into `$GOPATH/src/github.com/quickfixgo/quickfix`. All the necessary dependencies are either vendored, so you just need to type `make`. This will verify the code and run the unit tests. If this exits with exit status 0, then everything is working!
Next, using [Git](https://git-scm.com/), clone this repository into `$GOPATH/src/github.com/quickfixgo/quickfix`.

### Installing Dependencies

QuickFIX/Go uses [govendor](https://github.com/kardianos/govendor) to manage the vendored dependencies. Install govendor with `go get`:

```sh
$ go get github.com/kardianos/govendor
```

Run `govendor sync` to install the correct versioned dependencies into `vendor/, which Go 1.6+ automatically recognizes and loads.

```sh
$ $GOPATH/bin/govendor sync
```

**Note:** No vendored dependencies are included in the QuickFIX/Go source.

### Build and Test

The default make target runs [go vet](https://godoc.org/golang.org/x/tools/cmd/vet) and unit tests.

```sh
$ make
```

The default make target runs [go vet](https://godoc.org/golang.org/x/tools/cmd/vet) and unit tests.
If this exits with exit status 0, then everything is working!

### Acceptance Tests

Expand Down Expand Up @@ -78,14 +96,11 @@ If you are making changes to the generated code, you will need to include the ge

### Dependencies

QuickFIX/Go stores its dependencies under `vendor/`, which Go 1.6+ automatically recognize and load. We use [govendor](https://github.com/kardianos/govendor) to manage the vendored dependencies.


If you are developing QuickFIX/Go, there are a few tasks you might need to perform.
If you are developing QuickFIX/Go, there are a few tasks you might need to perform related to dependencies.

#### Adding a dependency

If you are adding a dependency, you will need to vendor it in the same Pull Request as the code that depends on it. You should do this in a separate commit from your code, as this makes PR review easier and Git history simpler to read in the future.
If you are adding a dependency, you will need update the govendor manifest in the same Pull Request as the code that depends on it. You should do this in a separate commit from your code, as this makes PR review easier and Git history simpler to read in the future.

To add a dependency:

Expand Down
13 changes: 0 additions & 13 deletions vendor/github.com/davecgh/go-spew/LICENSE

This file was deleted.

151 changes: 0 additions & 151 deletions vendor/github.com/davecgh/go-spew/spew/bypass.go

This file was deleted.

37 changes: 0 additions & 37 deletions vendor/github.com/davecgh/go-spew/spew/bypasssafe.go

This file was deleted.

Loading