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 | |
| parent | 8363d53bd27c621cb342fea15736a3b11231f2a4 (diff) | |
Move docs into one folder
| -rw-r--r-- | docs/README.md (renamed from api/README.md) | 18 | ||||
| -rw-r--r-- | docs/arrays.md (renamed from api/arrays.md) | 0 | ||||
| -rw-r--r-- | docs/booleans.md (renamed from api/booleans.md) | 0 | ||||
| -rw-r--r-- | docs/channels.md (renamed from api/channels.md) | 0 | ||||
| -rw-r--r-- | docs/enums.md (renamed from api/enums.md) | 0 | ||||
| -rw-r--r-- | docs/integers.md (renamed from api/integers.md) | 0 | ||||
| -rw-r--r-- | docs/nums.md (renamed from api/nums.md) | 0 | ||||
| -rw-r--r-- | docs/pointers.md (renamed from api/pointers.md) | 0 | ||||
| -rw-r--r-- | docs/ranges.md (renamed from api/ranges.md) | 0 | ||||
| -rw-r--r-- | docs/sets.md (renamed from api/sets.md) | 0 | ||||
| -rw-r--r-- | docs/structs.md (renamed from api/structs.md) | 0 | ||||
| -rw-r--r-- | docs/tables.md (renamed from api/tables.md) | 0 | ||||
| -rw-r--r-- | docs/text.md (renamed from api/text.md) | 0 | ||||
| -rw-r--r-- | docs/threads.md (renamed from api/threads.md) | 0 |
14 files changed, 14 insertions, 4 deletions
diff --git a/api/README.md b/docs/README.md index a7fe1262..55bc63ba 100644 --- a/api/README.md +++ b/docs/README.md @@ -1,9 +1,21 @@ -# API +# Documentation -Tomo has a small number of built-in functions and bunch of types. +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) @@ -64,5 +76,3 @@ Nothing, aborts the program. ```markdown fail("Oh no!") ``` - ---- diff --git a/api/arrays.md b/docs/arrays.md index 0453feb6..0453feb6 100644 --- a/api/arrays.md +++ b/docs/arrays.md diff --git a/api/booleans.md b/docs/booleans.md index 7d2c29a4..7d2c29a4 100644 --- a/api/booleans.md +++ b/docs/booleans.md diff --git a/api/channels.md b/docs/channels.md index 88cb46ff..88cb46ff 100644 --- a/api/channels.md +++ b/docs/channels.md diff --git a/api/enums.md b/docs/enums.md index 4123fbc4..4123fbc4 100644 --- a/api/enums.md +++ b/docs/enums.md diff --git a/api/integers.md b/docs/integers.md index 653322fd..653322fd 100644 --- a/api/integers.md +++ b/docs/integers.md diff --git a/api/nums.md b/docs/nums.md index 5b258010..5b258010 100644 --- a/api/nums.md +++ b/docs/nums.md diff --git a/api/pointers.md b/docs/pointers.md index ee7a5d8f..ee7a5d8f 100644 --- a/api/pointers.md +++ b/docs/pointers.md diff --git a/api/ranges.md b/docs/ranges.md index 4771bd58..4771bd58 100644 --- a/api/ranges.md +++ b/docs/ranges.md diff --git a/api/sets.md b/docs/sets.md index 850d1443..850d1443 100644 --- a/api/sets.md +++ b/docs/sets.md diff --git a/api/structs.md b/docs/structs.md index 4ab78fed..4ab78fed 100644 --- a/api/structs.md +++ b/docs/structs.md diff --git a/api/tables.md b/docs/tables.md index f4753efb..f4753efb 100644 --- a/api/tables.md +++ b/docs/tables.md diff --git a/api/text.md b/docs/text.md index 70708fe4..70708fe4 100644 --- a/api/text.md +++ b/docs/text.md diff --git a/api/threads.md b/docs/threads.md index 228fc8ac..228fc8ac 100644 --- a/api/threads.md +++ b/docs/threads.md |