add srcstep and correct PC-advancing during Sub-PC looping in ISACaller

[soc.git] / README.md

diff --git a/README.md b/README.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..c7c6c9963287d1af76ffe68103f2b3dae250b7ad 100644 (file)
--- a/README.md
+++ b/README.md
@@ -0,0 +1,32 @@
+# About
+The main SOC portion of Libre-SOC. A quad-core open source SOC with a GPU, VPU, and
+open source VLSI design cells.
+
+Open source down to VLSI Cells.
+
+# [Documentation](https://libre-soc.org/Documentation/index/)
+
+# Installation
+
+    make update
+    make install
+    make test # optional (ish)
+
+# Running Simulator tests
+
+qemu and gdb for Power 64 are required.  qemu can be installed with
+"apt-get install qemu-system-ppc64", however gdb needs compiling from
+source.  Obtain the latest tarball, unpack it, then:
+
+    cd gdb-9.1 (or other location)
+    mkdir build
+    cd build
+     ../configure --srcdir=.. --host=x86_64-linux --target=powerpc64-linux-gnu
+    make -j16
+    make install
+
+You will need to have installed the powerpc gnu gcc cross-compiler for
+this to work:
+
+    apt-get install gcc-9-powerpc64-linux-gnu
+