summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKai Gunger <kgunger12@gmail.com>2026-07-11 15:14:40 -0400
committerKai Gunger <kgunger12@gmail.com>2026-07-11 15:14:40 -0400
commit41c6c6169d991aa6d44185f58ff99a0a7dcc95f3 (patch)
tree093ec8f1930f84f9d321814c73c63ea9767740f3 /README.md
parentdd016e71af4f828a1b29f4e92df542a34dfd0f22 (diff)
Add license
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
new file mode 100644
index 0000000..88607eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# tnslc
+
+The reference compiler for the TNSL programming language. The compiler is written in TNSL.
+
+## Usage:
+
+Place the [bootstrap compiler](https://git.cshift.net/CircleShift/ctc) `ctc` in this folder and execute `build.sh tnslc`
+The compiler outputs x86 NASM compatible assembly.
+
+Examples:
+- `./ctc dummy.tnsl dummy.asm` - Run the bootstrap compiler on the dummy file, output to dummy.asm
+- `./build.sh tnslc` - Build the compiler
+
+## License
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.