Modify README.md
All checks were successful
Simple Mirror to GitHub / mirror (push) Successful in 8s
All checks were successful
Simple Mirror to GitHub / mirror (push) Successful in 8s
This commit is contained in:
parent
e369e0d1e6
commit
3308e2fae3
36
README.md
36
README.md
@ -1,4 +1,38 @@
|
||||
# FastInAHurry
|
||||
Financial market client/server orders simulator written in C++.
|
||||
|
||||
Low latency, data locality, and high performance are paramount.
|
||||
Low latency, data locality, and high performance are paramount.
|
||||
|
||||
# Build n' Run
|
||||
## Build
|
||||
Install nix (and optionally direnv) and run the `shell.nix` to load all dependencies in your local environment:
|
||||
|
||||
```bash
|
||||
nix-shell
|
||||
```
|
||||
|
||||
Then you can build the project
|
||||
```bash
|
||||
make
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
First, run the server:
|
||||
|
||||
```bash
|
||||
# Suppress output
|
||||
./build/server > /dev/null 2>&1 &
|
||||
|
||||
#OR
|
||||
|
||||
# Get hit with stdout
|
||||
./build/server &
|
||||
```
|
||||
|
||||
Then run the client:
|
||||
```bash
|
||||
./build/fastinahurry
|
||||
```
|
||||
|
||||
If you have direnv, run `direnv allow` and enjoy having your packages loaded automatically; no need to run `nix-shell` everytime you're in a new shell or load another `shell.nix` from another project.
|
Loading…
x
Reference in New Issue
Block a user