Skip to content

Commit

Permalink
Add to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@maximecb
maximecb committed Oct 31, 2023
1 parent 342ea29 commit 58ed633
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/design.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 58ed633

Please sign in to comment.