You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-9Lines changed: 24 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,8 @@ All documentation is available on [GoDoc](https://godoc.org/github.com/quickfixg
17
17
18
18
To install QuickFIX/Go, use `go get`:
19
19
20
-
```
21
-
go get github.com/quickfixgo/quickfix
20
+
```sh
21
+
$ go get github.com/quickfixgo/quickfix
22
22
```
23
23
24
24
### Staying up to date
@@ -42,15 +42,33 @@ If you wish to work on QuickFIX/Go itself, you will first need [Go](http://www.g
42
42
43
43
For local dev first make sure Go is properly installed, including setting up a [GOPATH](http://golang.org/doc/code.html#GOPATH).
44
44
45
-
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!
45
+
Next, using [Git](https://git-scm.com/), clone this repository into `$GOPATH/src/github.com/quickfixgo/quickfix`.
46
+
47
+
### Installing Dependencies
48
+
49
+
QuickFIX/Go uses [govendor](https://github.com/kardianos/govendor) to manage the vendored dependencies. Install govendor with `go get`:
50
+
51
+
```sh
52
+
$ go get github.com/kardianos/govendor
53
+
```
54
+
55
+
Run `govendor sync` to install the correct versioned dependencies into `vendor/, which Go 1.6+ automatically recognizes and loads.
56
+
57
+
```sh
58
+
$ $GOPATH/bin/govendor sync
59
+
```
60
+
61
+
**Note:** No vendored dependencies are included in the QuickFIX/Go source.
46
62
47
63
### Build and Test
48
64
65
+
The default make target runs [go vet](https://godoc.org/golang.org/x/tools/cmd/vet) and unit tests.
66
+
49
67
```sh
50
68
$ make
51
69
```
52
70
53
-
The default make target runs [go vet](https://godoc.org/golang.org/x/tools/cmd/vet) and unit tests.
71
+
If this exits with exit status 0, then everything is working!
54
72
55
73
### Acceptance Tests
56
74
@@ -78,14 +96,11 @@ If you are making changes to the generated code, you will need to include the ge
78
96
79
97
### Dependencies
80
98
81
-
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.
82
-
83
-
84
-
If you are developing QuickFIX/Go, there are a few tasks you might need to perform.
99
+
If you are developing QuickFIX/Go, there are a few tasks you might need to perform related to dependencies.
85
100
86
101
#### Adding a dependency
87
102
88
-
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.
103
+
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.
0 commit comments