feat(docs): add get started

Signed-off-by: Alex Chi <iskyzh@gmail.com>
This commit is contained in:
Alex Chi
2022-12-24 23:51:30 -05:00
parent fd4bb0162a
commit dd8ab3a134
2 changed files with 35 additions and 0 deletions

View File

@@ -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
```

View File

@@ -1,13 +1,21 @@
# LSM in a Week # LSM in a Week
[Overview](./00-overview.md) [Overview](./00-overview.md)
[Get Started](./00-get-started.md)
--- ---
# Tutorial
- [Store key-value pairs in little blocks](./01-block.md) - [Store key-value pairs in little blocks](./01-block.md)
- [And make them into an SST](./02-sst.md) - [And make them into an SST](./02-sst.md)
- [Now it's time to merge everything](./03-memtable.md) - [Now it's time to merge everything](./03-memtable.md)
- [The engine is on fire](./04-engine.md) - [The engine is on fire](./04-engine.md)
---
# WIP Chapters
- [Let's do something in the background](./05-compaction.md) - [Let's do something in the background](./05-compaction.md)
- [Be careful when the system crashes](./06-recovery.md) - [Be careful when the system crashes](./06-recovery.md)
- [A good bloom filter makes life easier](./07-bloom-filter.md) - [A good bloom filter makes life easier](./07-bloom-filter.md)