Allow the formal engine to perform a same-cycle result in the ALU
[soc.git] / README.md
index 559449b8c56b85d255fd61557307a6d89bd7d057..a298790ed4cc771fd8df233f595ef5957573c909 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,22 +1,27 @@
-# Installation
+# About
 
-python3 setup.py develop
+The main SOC portion of Libre-SOC. A quad-core Libre-licensed SoC woth a 
+hybrid 3D GPU-VPU-CPU, and using Libre-licensed design cells.
 
-# Running Simulator tests
+Libre-SOC is Libre down to the VLSI Cells, thanks to Chips4Makers FlexLib
+and Sorbonne University lip6.fr
 
-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:
+# Documentation
+
+See https://libre-soc.org/docs/
+
+# Installation
+
+Best done using the dev-env-setup scripts:
+https://git.libre-soc.org/?p=dev-env-setup.git;a=summary
 
-    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
+    make test # optional (ish)
 
-You will need to have installed the powerpc gnu gcc cross-compiler for
-this to work:
+# Running Simulator tests
 
-    apt-get install gcc-9-powerpc64-linux-gnu
+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.  The simplest way is to use this dev-env-script:
 
+https://git.libre-soc.org/?p=dev-env-setup.git;a=blob;f=ppc64-gdb-gcc;hb=HEAD