From 942f7f71d246fd110cda25b66f3b4e2304cdf371 Mon Sep 17 00:00:00 2001
From: Alex Chi <iskyzh@gmail.com>
Date: Sun, 28 Jan 2024 21:15:48 +0800
Subject: [PATCH] more development guide

Signed-off-by: Alex Chi <iskyzh@gmail.com>
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 3e3009c..eceeb67 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,22 @@ If you finished at least one full week of this tutorial, you can add your soluti
 
 ## Development
 
+**For Students**
+
+You should modify code in `mini-lsm-starter` directory.
+
+```
+cargo x install-tools
+cargo copy-test --week 1 --day 1
+cargo x scheck
+cargo run --bin mini-lsm-cli
+cargo run --bin compaction-simulator
+```
+
+**For Course Developers**
+
+You should modify `mini-lsm` and `mini-lsm-mvcc`
+
 ```
 cargo x install-tools
 cargo x check