From 9ca27a8738ac10a7f90c0bf16c14845ebf71bc5f Mon Sep 17 00:00:00 2001 From: Alex Chi Date: Wed, 24 Jan 2024 17:48:18 +0800 Subject: [PATCH] add mini-lsm cli in readme Signed-off-by: Alex Chi --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index ab2c7e93..0ea5d97e 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,20 @@ To do this, use `cargo x sync`. We have another repo mini-lsm-solution-checkpoint at [https://github.com/skyzh/mini-lsm-solution-checkpoint](https://github.com/skyzh/mini-lsm-solution-checkpoint). In this repo, each commit corresponds to a chapter in the tutorial. We will not update the solution checkpoint very often. +## Demo + +You can run the reference solution by yourself to gain an overview of the system before you start. + +``` +cargo run --bin mini-lsm-cli-ref +``` + +And we have a compaction simulator to experiment with your compaction algorithm implementation, + +``` +cargo run --bin compaction-simulator-ref +``` + ## Progress We are working on a new version of the mini-lsm tutorial that is split into 3 weeks.