From 088741aba433b60d4077d074d9f5e1112076a674 Mon Sep 17 00:00:00 2001
From: ~karx <karx@tilde.team>
Date: Sun, 7 Feb 2021 16:34:00 +0000
Subject: [PATCH] Add README

---
 README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..58c3061
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+# sandwich
+
+`sandwich` is a funny programming language written in Rust.
+
+## Running
+
+Use `cargo` to run an input file.
+
+```bash
+git clone https://tildegit.org/karx/sandwich
+cd sandwich
+cargo run <filename>
+```
+
+## Reference
+
+`sandwich` is comprised of *opcodes*. The syntax looks like this:
+```
+opcodeArguments
+```
+
+The currently available opcodes are as follows:
+
+- `p` - print out the arguments: `pHello pWorld!` 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.
+
+## Contributing
+
+
+For major changes, please open an issue first to discuss what you would like to change.
+Please make sure to update tests as appropriate.
+
+You can do two things to submit code: 
+
+### Make a pull request
+- Fork the repo
+- `git clone https://tildegit.org/yourusername/sandwich`
+- Make a feature branch: `git checkout -b feature/amazing-feature`
+- Make your changes and commit them: `git commit -am "My amazing commit message"`
+- Push changes to your fork: `git push -u origin master`
+- Create a pull request.
+
+### Send a patch
+
+You can send a patch to `karx@tilde.team`.
+Read [this guide](https://git-send-email.io) for more information.
+
+## License
+
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>
\ No newline at end of file