summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorWilliam Bryan <wilbryan@us.ibm.com>2016-10-04 10:48:27 -0500
committerWilliam A. Bryan <wilbryan@us.ibm.com>2016-10-06 17:53:38 -0400
commitd1bd2d6019d90a86b4299004a40556a1da70e3c9 (patch)
treeb705b75460c2d9318a9edf4369226ba863de31a9 /README.txt
parent64fcfd7e3f3899e761d21eda204b53114d494aaa (diff)
downloadtalos-occ-d1bd2d6019d90a86b4299004a40556a1da70e3c9.tar.gz
talos-occ-d1bd2d6019d90a86b4299004a40556a1da70e3c9.zip
Move LICENSE and README to top level
Change-Id: I4d31e04a165b3f661fff85e51654f3271f00a9be Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/30682 Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com> Reviewed-by: Christopher J. Cain <cjcain@us.ibm.com> Reviewed-by: William A. Bryan <wilbryan@us.ibm.com>
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..5c8f514
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,41 @@
+# On Chip Controller (OCC)
+
+#=======================
+# I. OBTAIN THE SOURCE
+#=======================
+
+To obtain the source code, you must use Git:
+
+git clone https://github.com/open-power/occ.git
+
+#=============================
+# II. BUILD THE BINARY IMAGE
+#=============================
+
+1. Obtain a current version of the GNU powerpc cross compiler
+
+2. Goto the src/ directory of the Git repository
+
+3. Build the binary files: make all
+
+4. Combine the binaries: make combineImage
+NOTE: This creates the OCC binary: image.bin
+
+5. Create the string file for tracing: make tracehash
+NOTE: This creates the debug trace hash file: occStringFile
+
+6. Repackage the PNOR to contain modified OCC image:
+op-build occ-rebuild openpower-pnor-rebuild
+
+#=====================
+# III. DOCUMENTATION
+#=====================
+
+Documentation can be found in the docs project of the open-power repository.
+https://github.com/open-power/docs/tree/master/occ
+
+#==============
+# IV. LICENSE
+#==============
+
+See the LICENSE file.
OpenPOWER on IntegriCloud