From 67e8f2dea0d4eec20a839d47f1fa6302a4a5f733 Mon Sep 17 00:00:00 2001
From: Bruce Hill <bruce@bruce-hill.com>
Date: Mon, 19 Aug 2024 00:23:02 -0400
Subject: Move docs into one folder

---
 docs/README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 docs/README.md

(limited to 'docs/README.md')

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..55bc63ba
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,78 @@
+# Documentation
+
+This is an overview of the documentation on Tomo.
+
+## Topics
+
+A few topics that are documented:
+
+- [Compilation Pipeline](compilation.md)
+- [Libraries/Modules](libraries.md)
+- [Special Methods](metamethods.md)
+- [Namespacing](namespacing.md)
+- [Operator Overloading](operators.md)
+
+## Types
+
+Information about Tomo's built-in types can be found here:
+
+- [Arrays](arrays.md)
+- [Booleans](booleans.md)
+- [Channels](channels.md)
+- [Enums](enums.md)
+- [Floating point numbers](nums.md)
+- [Integer Ranges](ranges.md)
+- [Integers](integers.md)
+- [Sets](sets.md)
+- [Structs](structs.md)
+- [Tables](tables.md)
+- [Text](text.md)
+- [Threads](threads.md)
+
+## Built-in Functions
+
+### `say`
+
+**Description:**  
+Prints a message to the console.
+
+**Usage:**  
+```markdown
+say(text:Text) -> Void
+```
+
+**Parameters:**
+
+- `text`: The text to print.
+
+**Returns:**  
+Nothing.
+
+**Example:**  
+```markdown
+say("Hello world!")
+```
+
+---
+
+### `fail`
+
+**Description:**  
+Prints a message to the console, aborts the program, and prints a stack trace.
+
+**Usage:**  
+```markdown
+fail(message:Text) -> Abort
+```
+
+**Parameters:**
+
+- `message`: The error message to print.
+
+**Returns:**  
+Nothing, aborts the program.
+
+**Example:**  
+```markdown
+fail("Oh no!")
+```
-- 
cgit v1.2.3