Add the root Makefile

This commit is contained in:
Tate, Hongliang Tian 2022-08-08 15:43:47 -07:00
parent 8e8fc95ede
commit 51c918c3fc
2 changed files with 28 additions and 2 deletions

21
Makefile Normal file
View File

@ -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

View File

@ -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...
While most code is written in Rust, the project-scope build process is governed
by Makefile.
```bash
make
```