diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..f786b704 --- /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 c1b7e331..57e071b8 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