From aa3dc422b43413e78cc406b7251767b2ab4f1543 Mon Sep 17 00:00:00 2001
From: Miquel Moreto <mmoreto@ac.upc.edu>
Date: Mon, 15 Oct 2012 10:54:47 -0700
Subject: [PATCH] Added first README file

---
 README | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 00000000..f8c326e6
--- /dev/null
+++ b/README
@@ -0,0 +1,79 @@
+Quick and dirty instructions:
+
+CHECKOUT THE CODE:
+
+  git submodule init
+  git submodule update
+
+  cd riscv-gcc-isasim
+  git submodule init
+  git submodule update
+
+
+BUILDING THE TOOLCHAIN:
+
+  To build RISC-V ISA simulator, frontend server, proxy kernel and newlib based GNU toolchain:
+
+    cd riscv-gcc-isasim
+    vi build.sh (Edit INSTALL_PREFIX)
+    ./build.sh
+
+  To build asm tests and benchmarks (you must have the RISC-V toolchain installed and in your path):
+
+    cd riscv-asmtests-bmarks/riscv-tests/
+    make
+
+    cd riscv-asmtests-bmarks/riscv-bmarks/
+    make
+
+
+BUILDING THE PROJECT:
+
+  To build the C simulator:
+
+    cd emulator
+    make dramsim2 (if DRAMSim2 is not installed and in your path)
+    make
+
+  To build the VCS simulator:
+
+    cd vlsi/build/vcs-sim-rtl
+    make
+
+  in either case, you can run a set of assembly tests or simple benchmarks:
+
+    make run-asm-tests
+    make run-vecasm-tests
+    make run-vecasm-timer-tests
+    make run-bmarks-test
+
+  To build a C simulator that is capable of VCD waveform generation:
+
+    cd emulator
+    make emulator-debug
+
+  And to run the assembly tests on the C simulator and generate waveforms:
+
+    make run-asm-tests-debug
+    make run-vecasm-tests-debug
+    make run-vecasm-timer-tests-debug
+    make run-bmarks-test-debug
+
+
+UPDATING TO A NEWER VERSION OF CHISEL:
+
+  To grab a newer version of chisel:
+
+    git submodule init
+    git submodule update
+    cd chisel
+    git pull origin master
+
+  Then, to compile it and install it into the rocket repo:
+
+    cd sbt
+    sbt package
+    cp chisel/target/scala-2.8.1/chisel_2.8.1-1.1.jar ../../sbt/work/lib
+
+  If you commit a new jar, you must also commit the updated chisel submodule.
+