diff --git a/doc/design.md b/doc/design.md index 53a953f..8829b79 100644 --- a/doc/design.md +++ b/doc/design.md @@ -20,9 +20,11 @@ feedback and ideas are welcome. We just ask that criticism be friendly and const ### Assembler UVM programs are contained in `.asm` files which are parsed by the UVM [assembler](/vm/src/asm.rs). -These files can be written by hand, or generated by a compiler. +These files can be written by hand, or generated by a compiler. The syntax is inspired by yasm/nasm and designed to be easy to read, and you can find some simple -examples under [vm/examples](/vm/examples). This repo also contains a toy C compiler (ncc) that emits +examples under [vm/examples](/vm/examples). The assembler supports both Python-style single-line +comments and C-style multiline comments for convenience. +This repo also contains a toy C compiler (ncc) that emits UVM asm files as its output. There is a plan for UVM to eventually support a binary image format to store programs as well, but