commit 4984839191acb049cadc4abf3c944c56559ec850
parent b34f91c933693b600c17c5d65a2d42d20721ba7e
Author: ~karx <karx@tilde.team>
Date: Sun, 7 Feb 2021 17:45:13 +0000
Add todo and example program
Diffstat:
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -21,9 +21,17 @@ opcodeArguments
The currently available opcodes are as follows:
-- `p` - print out the arguments: `pHello pWorld!` prints "Hello World!"
+- `p` - print out the arguments: `pHello World!` prints "Hello World!"
- `a`, `s`, `m`, `d` - add, subtract, multiply, and divide, respectively: `a2-2` adds 2 + 2.
-- `l` - declare a variable: `lv9` declares variable `v` with value `9`; doing `pv` prints out 9.
+- `l` - declare a variable: `lv9` declares variable `v` with value `9`; doing `p$v` prints out 9.
+
+Here's an example "Hello world" program:
+
+```
+lhHello
+lwWorld!
+p$h $w
+```
## Contributing
@@ -46,6 +54,13 @@ You can do two things to submit code:
You can send a patch to `karx@tilde.team`.
Read [this guide](https://git-send-email.io) for more information.
+## TODO
+
+- [ ] Better documentation
+- [ ] Ability to explicitly print math output and assign math output to variables
+- [ ] Add support for comments (should be pretty easy)
+- [ ] Unit testing and CI/CD
+
## License
This is free and unencumbered software released into the public domain.