A funny programming language written in Rust
Go to file
~karx 06c78ddf4d Add drone configuration 2021-02-07 19:48:03 +00:00
src Add test suite 2021-02-07 19:35:00 +00:00
.gitignore Remove inp.txt 2021-02-07 00:10:15 +00:00
Cargo.lock Initial commit 2021-02-03 15:19:11 -06:00
Cargo.toml Initial commit 2021-02-03 15:19:11 -06:00
LICENSE Add LICENSE 2021-02-07 16:29:24 +00:00
README.md Add drone configuration 2021-02-07 19:48:03 +00:00
drone.yml Add drone configuration 2021-02-07 19:48:03 +00:00

README.md

sandwich

sandwich is a funny programming language written in Rust.

Running

Use cargo to run an input file.

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 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 p$v prints out 9.
  • # - comment: the interpreter will skip this line.

Here's an example "Hello world" program:

lhHello
lwWorld!
p$h $w

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 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.

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