Skip to content

Commit 09edd6f

Browse files
ackleymiackleymi
committed
Adds goreleaser.
1 parent 34c582c commit 09edd6f

File tree

6 files changed

+188
-5
lines changed

6 files changed

+188
-5
lines changed

‎.goreleaser.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
before:
2+
hooks:
3+
- go mod tidy
4+
builds:
5+
- goos:
6+
- linux
7+
- darwin
8+
- windows
9+
ignore:
10+
- goos: linux
11+
goarch: 386
12+
- goos: darwin
13+
goarch: 386
14+
- goos: windows
15+
goarch: 386
16+
id: "executor"
17+
main: ./cmd/executor
18+
binary: executor
19+
- goos:
20+
- linux
21+
- darwin
22+
- windows
23+
ignore:
24+
- goos: linux
25+
goarch: 386
26+
- goos: darwin
27+
goarch: 386
28+
- goos: windows
29+
goarch: 386
30+
id: "tradeclient"
31+
main: ./cmd/tradeclient
32+
binary: tradeclient
33+
- goos:
34+
- linux
35+
- darwin
36+
- windows
37+
ignore:
38+
- goos: linux
39+
goarch: 386
40+
- goos: darwin
41+
goarch: 386
42+
- goos: windows
43+
goarch: 386
44+
id: "ordermatch"
45+
main: ./cmd/ordermatch
46+
binary: ordermatch
47+
48+
archives:
49+
- replacements:
50+
darwin: Darwin
51+
linux: Linux
52+
windows: Windows
53+
amd64: x86_64
54+
checksum:
55+
name_template: 'checksums.txt'
56+
snapshot:
57+
name_template: "{{ .Tag }}-next"
58+
changelog:
59+
sort: asc
60+
filters:
61+
exclude:
62+
- '^docs:'
63+
- '^test:'

‎LICENSE.txt renamed to ‎LICENSE

File renamed without changes.

‎README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[![Build Status](https://github.com/quickfixgo/examples/workflows/CI/badge.svg)](https://github.com/quickfixgo/examples/actions) [![GoDoc](https://godoc.org/github.com/quickfixgo/examples?status.png)](https://godoc.org/github.com/quickfixgo/examples) [![Go Report Card](https://goreportcard.com/badge/github.com/quickfixgo/examples)](https://goreportcard.com/report/github.com/quickfixgo/examples)
44

5-
* TradeClient is a simple console based trading client
6-
* Executor is a server that fills every limit order it receives
7-
* OrderMatch is a primitive matching engine
5+
* [TradeClient](cmd/tradeclient/README.md) is a simple console based trading client
6+
* [Executor](cmd/executor/README.md) is a server that fills every limit order it receives
7+
* [OrderMatch](cmd/ordermatch/README.md) is a primitive matching engine
88

99
All examples have been ported from [QuickFIX](http://quickfixengine.org)
1010

@@ -13,7 +13,7 @@ All examples have been ported from [QuickFIX](http://quickfixengine.org)
1313
### Build From Source
1414
To build and run the examples, you will first need [Go](https://www.golang.org) installed on your machine
1515

16-
Next, clone this repository with `git clone git@github.com:quickfixgo/examples.git`. All the necessary dependencies are vendored, so you just need to type `make build`. This will compile and install the examples into the `./bin` dir in the local copy of the repo. If this exits with exit status 0, then everything is working!
16+
Next, clone this repository with `git clone git@github.com:quickfixgo/examples.git`. This project uses go modules, so you just need to type `make build`. This will compile the examples executables in the `./bin` dir in your local copy of the repo. If this exits with exit status 0, then everything is working! You may need to pull the module deps with `go mod download`.
1717

1818
```sh
1919
make build
@@ -25,4 +25,4 @@ Following installation, the examples can be found in `./bin`. The examples are
2525

2626
### Licensing
2727

28-
This software is available under the QuickFIX Software License. Please see the [LICENSE.txt](https://github.com/quickfixgo/examples/blob/main/LICENSE.txt) for the terms specified by the QuickFIX Software License.
28+
This software is available under the QuickFIX Software License. Please see the [LICENSE](LICENSE) for the terms specified by the QuickFIX Software License.

‎cmd/executor/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Executor
2+
3+
## Usage
4+
A config file similar to the example config [here](../../config/executor.cfg) is required to run the executor.
5+
The cli command usage takes the form of
6+
7+
```sh
8+
executor [CONFIG_PATH_FILENAME]
9+
```
10+
where CONFIG_PATH_FILENAME defaults to `config/executor.cfg`
11+
12+
## Example Config Contents
13+
```
14+
[DEFAULT]
15+
SocketAcceptPort=5001
16+
SenderCompID=ISLD
17+
TargetCompID=TW
18+
ResetOnLogon=Y
19+
FileLogPath=tmp
20+
21+
[SESSION]
22+
BeginString=FIX.4.0
23+
24+
[SESSION]
25+
BeginString=FIX.4.1
26+
27+
[SESSION]
28+
BeginString=FIX.4.2
29+
30+
[SESSION]
31+
BeginString=FIX.4.3
32+
33+
[SESSION]
34+
BeginString=FIX.4.4
35+
36+
[SESSION]
37+
BeginString=FIXT.1.1
38+
DefaultApplVerID=7
39+
```

‎cmd/ordermatch/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Ordermatch
2+
3+
## Usage
4+
A config file similar to the example config [here](../../config/ordermatch.cfg) is required to run the ordermatch.
5+
The cli command usage takes the form of
6+
7+
```sh
8+
ordermatch [CONFIG_PATH_FILENAME]
9+
```
10+
where CONFIG_PATH_FILENAME defaults to `config/ordermatch.cfg`
11+
12+
## Example Config Contents
13+
```
14+
[DEFAULT]
15+
SocketAcceptPort=5001
16+
SenderCompID=ISLD
17+
TargetCompID=TW
18+
ResetOnLogon=Y
19+
FileLogPath=tmp
20+
21+
[SESSION]
22+
BeginString=FIX.4.0
23+
24+
[SESSION]
25+
BeginString=FIX.4.1
26+
27+
[SESSION]
28+
BeginString=FIX.4.2
29+
30+
[SESSION]
31+
BeginString=FIX.4.3
32+
33+
[SESSION]
34+
BeginString=FIX.4.4
35+
36+
[SESSION]
37+
BeginString=FIXT.1.1
38+
DefaultApplVerID=7
39+
```

‎cmd/tradeclient/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Tradeclient
2+
3+
## Usage
4+
A config file similar to the example config [here](../../config/tradeclient.cfg) is required to run the tradeclient.
5+
The cli command usage takes the form of
6+
7+
```sh
8+
tradeclient [CONFIG_PATH_FILENAME]
9+
```
10+
where CONFIG_PATH_FILENAME defaults to `config/tradeclient.cfg`
11+
12+
13+
## Example Config Contents
14+
```
15+
[DEFAULT]
16+
SocketConnectHost=127.0.0.1
17+
SocketConnectPort=5001
18+
HeartBtInt=30
19+
SenderCompID=TW
20+
TargetCompID=ISLD
21+
ResetOnLogon=Y
22+
FileLogPath=tmp
23+
24+
[SESSION]
25+
BeginString=FIX.4.0
26+
27+
[SESSION]
28+
BeginString=FIX.4.1
29+
30+
[SESSION]
31+
BeginString=FIX.4.2
32+
33+
[SESSION]
34+
BeginString=FIX.4.3
35+
36+
[SESSION]
37+
BeginString=FIX.4.4
38+
39+
[SESSION]
40+
BeginString=FIXT.1.1
41+
DefaultApplVerID=7
42+
```

0 commit comments

Comments
 (0)