diff --git a/README.md b/README.md index 53b9e0d..8403e93 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Read before getting started!! -First, read `src/main.rs`. Then, some background on this repo: +First, read [src/main.rs](https://github.com/voluntas-io/engineering-challenge/blob/main/src/main.rs). Then, some background on this repo: This repo uses the [FIX SBE standard](https://fixtrading.org/packages/simple-binary-encoding-technical-specification-v2-rc2/) for writing binary messages. The rust code abstracts this away for you, and you can simply use the helpers, as demonstrated in `main.rs`. @@ -14,8 +14,7 @@ XML, which in turn is used to generate rust code to encode and decode the messages. **You don't need to edit any of these files**. This explanation is simply to help you understand the origins of the various files in this repo. -The yaml for the schema you will be using is located in -`sbe_schemas/engineering_challenge/challenge_orderbook.yaml`. +If you're curious to see the YAML schema, take a look at [challenge_orderbook.yaml](https://github.com/voluntas-io/engineering-challenge/blob/main/sbe_schemas/engineering_challenge/challenge_orderbook.yaml). We also use a custom timestamp field, so that the Rust struct can use `chrono::DateTime` in the generated struct, and in SBE schema, it is a uint64 representing the timestamp as the number of microseconds since unix epoch.