summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLeo Tenenbaum <pommicket@gmail.com>2019-11-28 15:47:10 -0500
committerLeo Tenenbaum <pommicket@gmail.com>2019-11-28 15:47:10 -0500
commit76ff5d914def4984d5b599177032ded71632a5ec (patch)
tree36ae8ee6e70faf8019cccc8e27dfc764668fc560 /README.md
parent73e229539d1d287ccda5bf7f45519ed19c12aeaf (diff)
started dealing with calling "type functions"
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d946dce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+## toc
+
+`toc` is a language which compiles to C.
+
+---
+
+### About
+
+`toc` is currently in development. **It is not a stable language,
+and there are almost definitely bugs right now.**
+I would recommend against using it for anything big or important.
+Many parts of it may change in the future.
+
+`toc` improves on C's syntax (and semantics) in many ways,
+To declare `x` as an integer and set it to 5,
+you can do:
+
+```
+x := 5; // Declare x and set x to 5 (infer type)
+x : int = 5; // Explicitly make the type int.
+x : int; x = 5; // Declare x as an integer, then set it to 5.
+```
+
+`toc` is statically typed and has many of C's features, but
+it is nearly as fast in theory.
+
+See `docs` for more information.
+
+---
+
+### Help
+
+If you find a bug in `toc`, please [report an issue](https://github.com/pommicket/toc/issues) on GitHub. \ No newline at end of file