Create README.md

b4757d31 · Shetty Yttehs · f8c6a4f8 · b4757d31
Commit b4757d31 authored 8 months ago by Shetty Yttehs
Hide whitespace changes
Inline Side-by-side

Showing

with 40 additions and 0 deletions
+40 -0
--- a/README.md
+++ b/README.md
+# RISC-V64-MikuOS
+
+RISC-V64 OS written in Rust
+
+## Setup
+
+```bash
+make setup
+```
+
+## Usage
+
+### Build
+
+```bash
+make build
+```
+
+### Run
+
+```bash
+make run
+# or simply 'make'
+```
+
+### Debug
+
+```bash
+make debug
+```
+
+At the same dir:
+
+```bash
+make connect
+```
+
+## License
+
+MIT
\ No newline at end of file