QPQ-AG/gmbytecode
10
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases 9 Wiki Activity

Format Readme.

Browse Source
This commit is contained in:
Erik Stenman 2019-03-01 12:08:39 +01:00
parent cdccd1ade9
commit ef7c5750a4
1 changed files with 59 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

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