aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Waterman <waterman@cs.berkeley.edu>2015-05-10 22:29:24 -0700
committerAndrew Waterman <waterman@cs.berkeley.edu>2015-05-10 22:29:24 -0700
commitf2034b7472fa289136723968a492c695936cd152 (patch)
tree3662603ac76f8b095b9b6ab7bb51f238c9e87b46
parent87683e74f566afe6acaf77fd79cc0bf2746bf136 (diff)
downloadpk-f2034b7472fa289136723968a492c695936cd152.zip
pk-f2034b7472fa289136723968a492c695936cd152.tar.gz
pk-f2034b7472fa289136723968a492c695936cd152.tar.bz2
Update README
-rw-r--r--README.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/README.md b/README.md
index 35bd6a4..c19c4a0 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,30 @@
-RISC-V Proxy Kernel
-=====================
+RISC-V Proxy Kernel and Boot Loader
+=====================================
About
---------
-The RISC-V proxy kernel is a thin layer that services system calls generated
-by code built and linked with the RISC-V newlib port.
+The RISC-V Proxy Kernel, `pk`, is a lightweight application execution
+environment that can host statically-linked RISC-V ELF binaries. It is
+designed to support tethered RISC-V implementations with limited I/O
+capability and and thus handles I/O-related system calls by proxying them to
+a host computer.
+
+This package also contains the Berkeley Boot Loader, `bbl`, which is a
+supervisor execution environment for tethered RISC-V systems. It is
+designed to host the RISC-V Linux port.
Build Steps
---------------
We assume that the RISCV environment variable is set to the RISC-V tools
-install path, and that the riscv-gcc package is installed.
+install path, and that the riscv-gnu-toolchain package is installed.
$ mkdir build
$ cd build
$ ../configure --prefix=$RISCV/riscv64-unknown-elf --host=riscv64-unknown-elf
$ make
$ make install
+
+Alternatively, the GNU/Linux toolchain may be used to build this package,
+by setting `--host=riscv64-unknown-linux-gnu`.