summaryrefslogtreecommitdiff
path: root/README.html
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.html
parent73e229539d1d287ccda5bf7f45519ed19c12aeaf (diff)
started dealing with calling "type functions"
Diffstat (limited to 'README.html')
-rw-r--r--README.html33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.html b/README.html
new file mode 100644
index 0000000..d3476a5
--- /dev/null
+++ b/README.html
@@ -0,0 +1,33 @@
+<h2>toc</h2>
+
+<p><code>toc</code> is a language which compiles to C.</p>
+
+<hr />
+
+<h3>About</h3>
+
+<p><code>toc</code> is currently in development. <strong>It is not a stable language,
+and there are almost definitely bugs right now.</strong>
+I would recommend against using it for anything big or important.
+Many parts of it may change in the future.</p>
+
+<p><code>toc</code> improves on C's syntax (and semantics) in many ways,
+To declare <code>x</code> as an integer and set it to 5,
+you can do:</p>
+
+<p><code>
+x := 5; // Declare x and set x to 5 (infer type) <br />
+x : int = 5; // Explicitly make the type int. <br />
+x : int; x = 5; // Declare x as an integer, then set it to 5.
+</code></p>
+
+<p><code>toc</code> is statically typed and has many of C's features, but
+it is just as fast in theory.</p>
+
+<p>See <code>docs</code> for more information.</p>
+
+<hr />
+
+<h3>Help</h3>
+
+<p>If you find a bug in <code>toc</code>, please <a href="https://github.com/pommicket/toc/issues">report an issue</a> on GitHub.</p>