From: lkcl <lkcl@web>
Date: Sat, 23 Jul 2022 12:41:10 +0000 (+0100)
Subject: (no commit message)
X-Git-Tag: opf_rfc_ls005_v1~1083
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=5455c3862adc31d2fb5919ca2b795fd6f13b2154;p=libreriscv.git

---

diff --git a/docs/pypowersim.mdwn b/docs/pypowersim.mdwn
index dfa4c4747..5499712d1 100644
--- a/docs/pypowersim.mdwn
+++ b/docs/pypowersim.mdwn
@@ -14,7 +14,7 @@ Audio/Video CODECs (such as MP3).
 succesfully, you need to dump the memory contents and inspect them.
 
 
-## Pypowersim - PowerISA Simulator
+# Pypowersim - PowerISA Simulator
 
 Pypowersim is a PowerISA simulator written and Python.
 PowerISA binaries are decoded by a given ISA class instance.
@@ -28,9 +28,8 @@ or no arguments to get the help message:
 
 * python3 openpower-isa/src/openpower/decoder/isa/pypowersim.py
 
-## Tests
+# Tests
 
-### About
 
 The tests consist of running Pypowersim with several input arg's:
 
@@ -107,26 +106,22 @@ After execution 128 bytes are dumped from address 0x900000.
    9         -i audio/mp3/mp3_0_apply_window_float.bin
 ```
 
-### Before running the tests!
-
-**NOTE**: Is this correct?
+# Before running the tests!
 
 As the SVP64 spec and Libre-SOC CPU is developing, the available opcodes
 will grow. Make sure to update the auto-generated Python functions
 simulating the instructions by calling:
 
-* run "pywriter"
-
-(This is an installed utility, so should be in your PATH)
-
-### Download audio data (**only need to do this once?**)
+* run "pywriter". This is an installed utility, so should be in your PATH
+* Download audio data. Use the Makefile inside "openpower-isa/media" to 
+ download the audio samples.
 
-Call the Makefile inside "openpower-isa/media" to download the audio
-samples:
-
-* run "make wget"
+```
+$ pywriter
+$ make wget
+```
 
-### Running both tests
+# Running both tests
 
 Run the Makefile in the "openpower-isa/media" directory with "tests" arg:
 
@@ -136,9 +131,9 @@ All the debug will go to standard output, so you may wish to direct it to a
 log file (the file will be **big**!).
 
 To suppress verbose debug log, uncomment "#export SILENCELOG = 1" in the
-Makefile.
+Makefile or export it manually.
 
-### Running "mp3_x" tests individually
+# Running "mp3_x" tests individually
 
 Inside "openpower-isa/media" directory run:
 
@@ -147,7 +142,7 @@ Inside "openpower-isa/media" directory run:
 The "out" file will be created in the "media" directory. Change the name
 if you don't want the second test to overwrite the results of the first. 
 
-### Checking results
+# Checking results
 
 If you run both tests through the makefile, the shell script
 automatically compares the input "sample0" file with the