summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 8b467c4..2eb22a7 100644
--- a/readme.md
+++ b/readme.md
@@ -2,3 +2,21 @@
sanctuary forth is a 64-bit subroutine threaded forth system
for amd64 linux systems.
+
+## stack effect notation
+
+- `a`: memory address
+- `c`: one byte value
+- `n`: signed integer
+- `u`: unsigned integer
+- `?`: boolean flag
+
+## Glossary
+the following is a list of words available in this forth. (neither of these have been implemented yet i'm just putting them here in the meantime lol)
+
+### `dp ( -- a )`
+`dp` is a variable that contains the lowest free byte of memory in user memory.
+
+### `here ( -- a )`
+`here` yields the address of the first available byte
+in user memory.