go-vise

commit 07555fee918cb4043c9a1087173151171fd21eb5
parent aab804e8ffb8c1c7dd4f0de8a6ec72d9717f4697
Author: lash <dev@holbrook.no>
Date:   Wed,  5 Apr 2023 08:41:58 +0100

Update readme

Diffstat:
M
README.md
 | 
18
+++++++++++-------

1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -178,6 +178,11 @@ It expects all replacement symbols to be available at time of rendering, and has
 0007                          # HALT                - stop execution
 ```
 
+## Assembly examples
+
+See `testdata/*.fst`
+
+
 ## Development tools
 
 Located in the `dev/` directory.
@@ -203,17 +208,16 @@ If `data_directory` is not set, current directory will be used.
 if `root_symbol` is not set, the symbol `root` will be used.
 
 
-### Disassembler
+### Assembler
 
-`go run ./dev/testdata/ <binary_file>`
+`go run ./dev/asm <assembly_file>`
 
-The output from this tool is to be considered debugging output, as the assembly language isn't formalized yet.
+Will output bytecode on STDOUT generated from a valid assembly file.
 
-In the meantime, it will at least list all the instructions, and thus validate the file.
 
+### Disassembler
 
-### Assembler
+`go run ./dev/disasm/ <binary_file>`
 
-**TBD**
+Will list all the instructions on STDOUT from a valid binary file.
 
-An assmebly language will be defined to generate the _routing_ and _execution_ bytecodes for each menu node.