diff --git a/mini-lsm-book/src/00-get-started.md b/mini-lsm-book/src/00-get-started.md new file mode 100644 index 0000000..bbf8aa4 --- /dev/null +++ b/mini-lsm-book/src/00-get-started.md @@ -0,0 +1,27 @@ +# Get Started + +The starter code and reference solution is available at [https://github.com/skyzh/mini-lsm](https://github.com/skyzh/mini-lsm). + +## Install Rust + +See [https://rustup.rs](https://rustup.rs) for more information. + +## Clone the repo + +``` +git clone https://github.com/skyzh/mini-lsm +``` + +## Starter code + +``` +cd mini-lsm/mini-lsm-starter +code . +``` + +## Run tests + +``` +cargo x copy-test day1 +cargo x scheck +``` diff --git a/mini-lsm-book/src/SUMMARY.md b/mini-lsm-book/src/SUMMARY.md index 8aaf4fe..6e8190f 100644 --- a/mini-lsm-book/src/SUMMARY.md +++ b/mini-lsm-book/src/SUMMARY.md @@ -1,13 +1,21 @@ # LSM in a Week [Overview](./00-overview.md) +[Get Started](./00-get-started.md) --- +# Tutorial + - [Store key-value pairs in little blocks](./01-block.md) - [And make them into an SST](./02-sst.md) - [Now it's time to merge everything](./03-memtable.md) - [The engine is on fire](./04-engine.md) + +--- + +# WIP Chapters + - [Let's do something in the background](./05-compaction.md) - [Be careful when the system crashes](./06-recovery.md) - [A good bloom filter makes life easier](./07-bloom-filter.md)