pysvp64db: fix traversal
[openpower-isa.git] / README.md
index 28705179c2c95f968de2f55589e16fd515131cc0..e664b8f02499c819320443e107e2581308179cf4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,11 +22,8 @@ and the following scripts:
 
 Once those are sorted, installation and setup is as follows:
 
-```
-    python3 setup.py develop
-    make svanalysis
-    make pywriter
-```
+* python3 setup.py develop
+* make generate
 
 # Usage
 
@@ -61,7 +58,7 @@ https://git.libre-soc.org/?p=soc.git;a=blob;f=src/soc/simple/test/test_issuer.py
 The ISACaller itself of course needed to bootstrap up by having unit
 tests that explicitly and clearly checked against expected values.  Example:
 
-    python openpower/decoder/isa/test_caller.py
+* python openpower/decoder/isa/test_caller.py
 
 These tests pre-prepare the register files, then check afterwards that
 the result of operation is as expected.  In this way, at least basic
@@ -73,16 +70,34 @@ functionality of ISACaller can be confirmed in a stand-alone fashion
 Contributions are welcomed as this is a collaborative Libre Project.
 Libre-SOC is covered by the following dead-simple Charter:
 
-    https://libre-soc.org/charter/
+* https://libre-soc.org/charter/
 
 Contributions even to the Charter, in the form of appropriate Dilbert
 cartoons especially appreciated:
 
-    https://libre-soc.org/charter/discussion/
+* https://libre-soc.org/charter/discussion/
 
 # Copyrights
 
 All programs are written by Libre-SOC team members are LGPLv3+.
 However the specification and the CSV files came from their
-respective Copyright holders (IBM, OpenPOWER Foundation, Microwatt)
+respective Copyright holders (IBM, OpenPOWER Foundation, Microwatt).
+
+Bear in mind that the *facts* in a specification may not be copyrighted,
+however the document (or source code) *containing* those facts can be and
+is copyrightable.  In this repository, the **facts** were extracted
+(from Microwatt and from the OpenPOWER ISA Technical Specification).
+
+Therefore, you, likewise, may *also* extract the **facts** from this
+source code, but for the actual source code itself you must respect the
+terms and conditions of the LGPLv3+ License in which those facts happen
+to be embedded.
+
+# Other Unit Tests
+
+There do exist other unit tests for OpenPOWER.  List them here:
+
+* https://bitbucket.org/sandip4n/gem5-powerpc64le-tests/src/master/
+* http://sources.buildroot.net/kvm-unit-tests/git/powerpc/
+* https://github.com/lioncash/DolphinPPCTests