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
+29-11Lines changed: 29 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,22 @@ See [examples](https://github.com/quickfixgo/examples) for some simple examples
32
32
33
33
### FIX Message Generation
34
34
35
-
QuickFIX/Go includes fields, enums, messages, and message components generated from the FIX 4.0 - FIX5.0SP2 specs. For most FIX applications, these generated resources are sufficient. Custom FIX applications may generate source specific to the FIX spec of that application using the `generate-fix` tool included with QuickFIX/Go.
35
+
QuickFIX/Go includes separate packages for tags, fields, enums, messages, and message components generated from the FIX 4.0 - FIX5.0SP2 specs. See:
For most FIX applications, these generated resources are sufficient. Custom FIX applications may generate source specific to the FIX spec of that application using the `generate-fix` tool included with QuickFIX/Go.
36
51
37
52
Following installation, `generate-fix` is installed to `$GOPATH/bin/generate-fix`. Run `$GOPATH/bin/generate-fix --help` for usage instructions.
38
53
@@ -71,6 +86,16 @@ $ make
71
86
72
87
If this exits with exit status 0, then everything is working!
73
88
89
+
### Generated Code
90
+
91
+
Generated code from the FIX40-FIX50SP2 specs are available as separate repos under the [QuickFIX/Go organization](https://github.com/quickfixgo). The source specifications for this generated code is located in `spec/`. Generated code can be identified by the `.generated.go` suffix. Any changes to generated code must be captured by changes to source in `cmd/generate-fix`. After making changes to the code generator source, run the following to re-generate the source
92
+
93
+
```sh
94
+
$ make generate-dist
95
+
```
96
+
97
+
If you are making changes to the generated code, please create Pull Requests for these changes for the affected repos.
98
+
74
99
### Acceptance Tests
75
100
76
101
QuickFIX/Go has a comprehensive acceptance test suite covering the FIX protocol. These are the same tests used across all QuickFIX implementations.
@@ -79,22 +104,15 @@ QuickFIX/Go acceptance tests depend on ruby in path.
79
104
80
105
To run acceptance tests,
81
106
107
+
# generate code locally
108
+
make generate
109
+
82
110
# build acceptance test rig
83
111
make build_accept
84
112
85
113
# run acceptance tests
86
114
make accept
87
115
88
-
### Generated Code
89
-
90
-
For convenience, generated code from the FIX40-FIX50SP2 specs are included in the QuickFIX/Go repo. The source specifications for this generated code is located in `spec/`. Generated code can be identified by the `.generated.go` suffix. Any changes to generated code must be captured by changes to source in `cmd/generate-fix`. After making changes to the code generator source, run the following to re-generate the source
91
-
92
-
```sh
93
-
$ make generate
94
-
```
95
-
96
-
If you are making changes to the generated code, you will need to include the generated source in the same Pull Request as the changes made to the code generator. 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.
97
-
98
116
### Dependencies
99
117
100
118
If you are developing QuickFIX/Go, there are a few tasks you might need to perform related to dependencies.
0 commit comments