From 07555fee918cb4043c9a1087173151171fd21eb5 Mon Sep 17 00:00:00 2001 From: lash Date: Wed, 5 Apr 2023 08:41:58 +0100 Subject: [PATCH] Update readme --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8a75e03..0ef5de3 100644 --- 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 - -`go run ./dev/testdata/ ` - -The output from this tool is to be considered debugging output, as the assembly language isn't formalized yet. - -In the meantime, it will at least list all the instructions, and thus validate the file. - - ### Assembler -**TBD** +`go run ./dev/asm ` + +Will output bytecode on STDOUT generated from a valid assembly file. + + +### Disassembler + +`go run ./dev/disasm/ ` + +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.