Add README.md for kelvin. Change-Id: Ice8cac210ba6b681815a9d3c1342033ff195a32a
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9663133 --- /dev/null +++ b/README.md
@@ -0,0 +1,18 @@ +# Kelvin + +Kelvin is a RISC-V32IM core with a custom instruction set. + +## Building + +Kelvin uses [bazel](https://bazel.build/) as it's build system. The Verilated +simulator for Kelvin can be generated using: + +```bash +bazel build //tests/verilator_sim:core_sim +``` + +The verilog source for the Kelvin core can be generated using: + +```bash +bazel build //hdl/chisel:core_cc_library_emit_verilog +```