From 51c918c3fcbffb2d4e2f6baa6af22ca23414571b Mon Sep 17 00:00:00 2001
From: "Tate, Hongliang Tian" <tate.thl@antgroup.com>
Date: Mon, 8 Aug 2022 15:43:47 -0700
Subject: [PATCH] Add the root Makefile

---
 Makefile  | 21 +++++++++++++++++++++
 README.md |  9 +++++++--
 2 files changed, 28 insertions(+), 2 deletions(-)
 create mode 100644 Makefile

diff --git a/Makefile b/Makefile
new file mode 100644
index 000000000..f786b7047
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,21 @@
+.PHONY: all build clean docs fmt test 
+
+all: build test
+
+build:
+	@cd src && cargo build
+
+test: build
+	@cd src && cargo test
+
+docs:
+	@cd src && cargo doc
+	@echo "" 								# Add a blank line
+	@cd docs && mdbook build
+
+fmt:
+	@cd src && cargo fmt
+
+clean:
+	@cd src && cargo clean
+	@cd docs && mdbook clean
\ No newline at end of file
diff --git a/README.md b/README.md
index c1b7e331b..57e071b8d 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,11 @@ While there is nothing revolutionary in KxOS, it does explore some new design po
 - [ ] Iteration 5: Add a minimal set of OS-level virtualization functionalities
 - [ ] More iterations...
 
-## Technical Details
+## How to build and test
 
-TODO...
\ No newline at end of file
+While most code is written in Rust, the project-scope build process is governed 
+by Makefile.
+
+```bash
+make
+```
\ No newline at end of file