japl
/
JustAnotherJAPL
mirror of https://github.com/japl-lang/JustAnotherJAPL.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added headers to bytecode.md

This commit is contained in:
nocturn9x 2021-07-13 16:15:49 +02:00
parent 7abf56a884
commit 7eff6834c7
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/bytecode.md
View File

@ -0,0 +1,17 @@
# NimVM - Bytecode Serialization Standard
## Rationale
This document aims to lay down a simple, extensible and linear format for serializing and deserializing
compiled NimVM's code to a buffer (be it an actual OS file or an in-memory stream).
## Disclaimer
----------------------------------------------
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in [RFC2119](https://datatracker.ietf.org/doc/html/rfc2119).
Literals in this document will be often surrounded by double quotes to make it obvious they're not part of a sentence. To
avoid ambiguity, this document will always specify explicitly if double quotes need to be considered as part of a term or not,
which means that if it is not otherwise stated they are to be considered part of said term. In addition to quotes, literals
may be formatted in monospace to make them stand out more in the document.
TODO