diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2024-08-19 00:23:02 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2024-08-19 00:23:02 -0400 |
| commit | 67e8f2dea0d4eec20a839d47f1fa6302a4a5f733 (patch) | |
| tree | 3f9d28687b6ac824b5676c963ef9964ac4857c4a /docs/README.md | |
| parent | 8363d53bd27c621cb342fea15736a3b11231f2a4 (diff) | |
Move docs into one folder
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 78 |
1 files changed, 78 insertions, 0 deletions
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!") +``` |
