diff --git a/README.md b/README.md new file mode 100644 index 0000000..0f04e47 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# ATS Esper + +## Setup + +- Copy `config/config.properties.sample` to `config/config.properties`. +- Edit `config/config.properties` to add OANDA account settings. + +## Run + +If running from a distribution zip file, unzip and cd into the ATS_Esper +directory, then: + +`./bin/ATS_Esper -h csv/EURUSD-2017-01-small.csv epl/trading_system_1.epl` + +If running from a git checkout using gradle, the equivalent is: + +`./gradlew run -PrunArgs="-h csv/EURUSD-2017-01-small.csv epl/trading_system_1.epl"` + +Logs will be written to stdout and `logs/run.log`.