Format Readme.

This commit is contained in:
Erik Stenman 2019-03-01 12:08:39 +01:00
parent cdccd1ade9
commit ef7c5750a4

View File

@ -1,17 +1,13 @@
# aebytecode
=====
An library and stand alone assembler for aeternity bytecode.
This version supports Aevm bytecode and Fate bytecode.
## Build
-----
$ make
## Fate Code
---------
Fate code exists in 3 formats:
@ -29,21 +25,25 @@ The internal format is described in a separate document.
The text representation is described below.
### Fate Assembler Code
-------------------
Assembler code can be read from a file.
The assembler has the following format:
Comments start with 2 semicolons and runs till end of line
`;; This is a comment`
Opcode mnemonics start with an upper case letter.
`DUP`
Identifiers start with a lower case letter
`an_identifier`
References to function arguments start with arg followed by an integer
`arg0`
References to variables/registers start with var followed by an integer
`var0`
References to stack postions is either a (for stack 0)
or start with stack followed by an integer
`stack1`
@ -80,7 +80,8 @@ The assembler has the following format:
9. Varaiants: (| Size | Tag | ( Elements ) |)
`(| 42 | 12 | ( "foo", 12) |)`
Where Digits: [0123456789]
Where
Digits: [0123456789]
Hexdigits: [0123456789abcdef]
base58char: [123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]
Characters any printable ascii character 0..255 (except " no quoting yet)