From f2034b7472fa289136723968a492c695936cd152 Mon Sep 17 00:00:00 2001 From: Andrew Waterman Date: Sun, 10 May 2015 22:29:24 -0700 Subject: Update README --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) (limited to 'README.md') 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`. -- cgit v1.1