Skip to content

Commit d62bda4

Browse files
committed
Updated readme
1 parent 64bf581 commit d62bda4

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ I'm extracting results and creating various graphs for trend analyses using SciP
1818

1919
## Setup
2020

21-
This backtesting engine can pull tick data from local files or from a Postgres database (I'm using QuestDB). Strategy execution is dispatched via a Redis list called `strategy_queue`, with each entry a Base64-encoded JSON payload the `load` subcommand enqueues strategies (LPUSH) and the `run` subcommand dequeues and executes them (RPOP). The default workflow expects a local `redis-server` listening on `127.0.0.1:6379`.
21+
This backtesting engine can pull tick data from local files or from a Postgres database (I'm using QuestDB). Strategy execution is dispatched via a Redis list called `strategy_queue`, with each entry a Base64-encoded JSON payload, the `load` subcommand enqueues strategies (LPUSH) and the `run` subcommand dequeues and executes them (RPOP). The default workflow expects a local `redis-server` listening on `127.0.0.1:6379`.
2222

2323
### Clone with submodules
2424

@@ -55,7 +55,7 @@ The canonical CI prerequisite list lives in `.github/workflows/scripts/brew.sh`
5555

5656
### Build dependencies
5757

58-
`libpqxx` is built once via CMake. `boost-decimal` is header-only and pulled in via `add_subdirectory` from the top-level `CMakeLists.txt` nothing to build. The script below handles the libpqxx build:
58+
`libpqxx` is built once via CMake. `boost-decimal` is header-only and pulled in via `add_subdirectory` from the top-level `CMakeLists.txt`, nothing to build. The script below handles the libpqxx build:
5959

6060
```
6161
bash ./scripts/build_dep.sh
@@ -89,7 +89,7 @@ Xcode - Library Path
8989

9090
### Run via terminal
9191

92-
`bash ./scripts/run.sh` builds the project, thenif `redis-cli ping` reaches a local Redis enqueues an inline JSON strategy via `load` and executes it via `run localhost`. If Redis is unreachable the script prints a message and exits cleanly (see `scripts/run.sh:22-25`), so first-time users without Redis still get a clear signal.
92+
`bash ./scripts/run.sh` builds the project, then, if `redis-cli ping` reaches a local Redis, enqueues an inline JSON strategy via `load` and executes it via `run localhost`. If Redis is unreachable the script prints a message and exits cleanly (see `scripts/run.sh:22-25`), so first-time users without Redis still get a clear signal.
9393

9494
The `BacktestingEngine` binary exposes a subcommand CLI:
9595

@@ -118,7 +118,7 @@ Defaults are `127.0.0.1:6379` for the Redis endpoint and `strategy_queue` for th
118118

119119
### Contributing
120120

121-
This is an active solo experiment, so I'm not accepting pull requests right now but please fork freely and use [GitHub Issues](https://github.com/mccaffers/backtesting-engine-cpp/issues) for bugs, questions, and ideas. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
121+
This is an active solo experiment, so I'm not accepting pull requests right now, but please fork freely and use [GitHub Issues](https://github.com/mccaffers/backtesting-engine-cpp/issues) for bugs, questions, and ideas. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
122122

123123
### License
124124
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)