diff --git a/README.md b/README.md index 4431461..d4946a4 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,6 @@ cargo x install-tools cargo x check cargo x book ``` + +If you changed public API in the reference solution, you might also need to synchronize it to the starter crate. +To do this, use `cargo x sync`. diff --git a/mini-lsm-book/src/00-overview.md b/mini-lsm-book/src/00-overview.md index 4f86f47..d61a3e9 100644 --- a/mini-lsm-book/src/00-overview.md +++ b/mini-lsm-book/src/00-overview.md @@ -89,6 +89,10 @@ In this tutorial, we will build the LSM tree structure in 7 days: * Day 6: Recovery. We will implement WAL and manifest so that the engine can recover after restart. * Day 7: Bloom filter and key compression. They are widely-used optimizations in LSM tree structures. +## Development Guide + We provide you starter code (see `mini-lsm-starter` crate), where we simply replace all function body with `unimplemented!()`. You can start your project based on this starter code. We provide test cases, but they are very simple. We recommend you to think carefully about your implementation and write test cases by yourself. + +You can use `cargo x scheck` to run all test cases and do style check in your codebase. diff --git a/mini-lsm-starter/src/table/tests.rs b/mini-lsm-starter/src/table/tests.rs index 8b13789..cc38899 100644 --- a/mini-lsm-starter/src/table/tests.rs +++ b/mini-lsm-starter/src/table/tests.rs @@ -1 +1 @@ - +//! Please copy `mini-lsm/src/table/tests.rs` here so that you can run tests.