diff --git a/api/README.md b/docs/README.md similarity index 71% rename from api/README.md rename to docs/README.md index a7fe126..55bc63b 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 similarity index 100% rename from api/arrays.md rename to docs/arrays.md diff --git a/api/booleans.md b/docs/booleans.md similarity index 100% rename from api/booleans.md rename to docs/booleans.md diff --git a/api/channels.md b/docs/channels.md similarity index 100% rename from api/channels.md rename to docs/channels.md diff --git a/api/enums.md b/docs/enums.md similarity index 100% rename from api/enums.md rename to docs/enums.md diff --git a/api/integers.md b/docs/integers.md similarity index 100% rename from api/integers.md rename to docs/integers.md diff --git a/api/nums.md b/docs/nums.md similarity index 100% rename from api/nums.md rename to docs/nums.md diff --git a/api/pointers.md b/docs/pointers.md similarity index 100% rename from api/pointers.md rename to docs/pointers.md diff --git a/api/ranges.md b/docs/ranges.md similarity index 100% rename from api/ranges.md rename to docs/ranges.md diff --git a/api/sets.md b/docs/sets.md similarity index 100% rename from api/sets.md rename to docs/sets.md diff --git a/api/structs.md b/docs/structs.md similarity index 100% rename from api/structs.md rename to docs/structs.md diff --git a/api/tables.md b/docs/tables.md similarity index 100% rename from api/tables.md rename to docs/tables.md diff --git a/api/text.md b/docs/text.md similarity index 100% rename from api/text.md rename to docs/text.md diff --git a/api/threads.md b/docs/threads.md similarity index 100% rename from api/threads.md rename to docs/threads.md