Update README.md
This commit is contained in:
parent
99b25dec07
commit
f6dcb4315b
|
@ -1,8 +1,10 @@
|
|||
# example-os
|
||||
An example bare bones OS template for RISC V.
|
||||
An example bare bones OS template for RISC-V.
|
||||
|
||||
## Build instructions
|
||||
Install [the Newlib GNU RISC V toolchain](https://github.com/riscv/riscv-gnu-toolchain#installation-newlib) and do `make` to build. Do `make run` to run. It should print out a bunch of debug information related to OpenSBI and then a single `a`.
|
||||
Install [the Newlib GNU RISC-V toolchain](https://github.com/riscv/riscv-gnu-toolchain#installation-newlib) and do `make` to build. Do `make run` to run. It should print out a bunch of debug information related to OpenSBI and then a single `a`.
|
||||
|
||||
Alternatively, you can install Clang and use `make CC=clang`.
|
||||
|
||||
## Exiting QEMU
|
||||
This is the new "how to exit Vi" I guess. To exit, press control+a, unpress those keys, and then press x.
|
||||
|
@ -10,7 +12,7 @@ This is the new "how to exit Vi" I guess. To exit, press control+a, unpress thos
|
|||
## Debugging
|
||||
Execute `make gdb` and then `make run`.
|
||||
|
||||
If you'd like to trace the execution since the beginning, uncomment the `# -S` at the end of the line in the makefile and run. This halts the emulator until a gdb connection is established.
|
||||
If you'd like to trace the execution since the beginning, use `make run WAIT_GDB=1`. This halts the emulator until a gdb connection is established.
|
||||
|
||||
## Resources
|
||||
- [OpenSBI docs](https://github.com/riscv/riscv-sbi-doc/blob/master/riscv-sbi.adoc)
|
||||
|
|
Reference in New Issue