diff --git a/lang/README.md b/lang/README.md new file mode 100644 index 0000000..8d88a1c --- /dev/null +++ b/lang/README.md @@ -0,0 +1,24 @@ +# Language prototype project + +This is the prototype language for the Tardis prototype project. + +This is mainly to get an environment up and running. This means no fancy +features, no tests, no optimizations, etc. + +Design notes: + +- Bytecode VM is stack-based with indexing +- Garbage collection is done using reference counting +- Stack is shifted on function call +- Empty function arguments are re-used for return values +- Callee cleans up unused stack space when returning + +## License + +All documentation and software for this project is under the MIT license unless otherwise specified. + +Copyright: 2023 Casey Reeves + +Copyright: 2023 John Watts + +SPDX-License-Identifier: MIT