aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README37
-rw-r--r--README.md20
2 files changed, 20 insertions, 37 deletions
diff --git a/README b/README
deleted file mode 100644
index e12f8f5..0000000
--- a/README
+++ /dev/null
@@ -1,37 +0,0 @@
-==========================================================================
-Modular C++ Build System Template
-==========================================================================
-# Author : Christopher Batten
-# Date : September 24, 2008
-# Version : (under version control)
-
-This is a template for the Modular C++ Build System. Please refer to the
-following documentation for more information on the build system:
-
- - 'mcppbs-uguide.txt' : Modular C++ Build System User Guide
- - 'utst/utst-uguide.txt' : Unit Testing Framework User Guide
- - 'style-guide.txt' : C++ Coding Style Guide
-
-Developers should eventually replace this 'README' file with information
-on their new project. It is recommended that the new 'README' file keep
-pointers to the above documentation so that end-users can learn about
-the build system. You may also want to keep the version information
-around so that you know what version of the build system you are using.
-
---------------------------------------------------------------------------
-Template Instantiation
---------------------------------------------------------------------------
-
- - Update project metadata (name, maintainer, etc) in 'configure.ac'
- - Run 'autoconf && autoheader' in project's root directory
- - Add subprojects and update the list in 'configure.ac'
-
---------------------------------------------------------------------------
-Build Steps
---------------------------------------------------------------------------
-
- % mkdir build
- % cd build
- % CC=riscv-gcc ../configure --prefix=$RISCV/target --host=riscv
- % make
- % make install
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ed9637
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+RISC-V Proxy Kernel
+=====================
+
+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.
+
+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.
+
+ $ mkdir build
+ $ cd build
+ $ CC=riscv-gcc ../configure --prefix=$RISCV/target --host=riscv
+ $ make
+ $ make install