Initial commit

1 files changed, 18 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..80e7f80
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# libtrv
+
+Newlib port stuff for trve.
+
+## Usage
+
+Compile your program with `-nostdlib` and `-march=rv64im -mabi=lp64 -mcmodel=medany`, and
+manually linked to the newlib libc and libtrv itself, using the linker script
+from the TRVE repository. Do NOT use a crt0 from outside libtrv (which includes one) and make
+sure newlib is built with newlib provided syscalls disabled and you do not link libgloss.
+Also, the linking with newlib and libtrv should be in a group, as there are crossing dependencies
+between the 2.
+
+## Build process
+
+libtrv is built with cmake. You will need a cmake toolchain configuration file, which should define a C compiler and potentially an install prefix.
+
+The libtrv library will be installed under the lib directory of the prefix, and headers under include/trv.