From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Fri, 23 Apr 2021 18:03:45 +0000 (+0100)
Subject: update README
X-Git-Tag: 0.0.1~15
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=4a73ed8633945ab25107532fbd622a8db94d0043;p=openpower-isa.git

update README
---

diff --git a/Makefile b/Makefile
index 241bd63e..47677331 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,6 @@
 PYTHON3 ?= "python3"
 
-.PHONY: help Makefile gitupdate svanalysis test htmlupload pypiuload pywriter
+.PHONY: help Makefile gitupdate svanalysis test htmlupload pypiupload pywriter
 
 gitupdate:
 	git submodule init
diff --git a/README.md b/README.md
index e69de29b..16d27b59 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,14 @@
+# OpenPOWER ISA resources
+
+OpenPOWER ISA resources, including a python-based simulator.
+Includes machine-readable versions of the OpenPOWER v3.0B 
+specification, from which the python-based simulator is
+compiled (python-ply) into python.  Additional languages
+(c, c++) are planned.
+
+# Installation
+
+    python setup.py develop
+    make svanalysis
+    make pywriter
+