Sorted out some folders for the docs

This commit is contained in:
2023-02-16 21:44:06 +11:00
committed by GitHub
parent 329d085beb
commit 0b885d0a30
15 changed files with 30 additions and 65 deletions

75
index.md Normal file
View File

@@ -0,0 +1,75 @@
<p align="center">
<image src="toylogo.png" />
</p>
[![Running Comprehensive Tests](https://github.com/Ratstail91/Toy/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/Ratstail91/Toy/actions/workflows/c-cpp.yml)
# Preamble
The Toy programming language is a procedural bytecode-intermediate interpreted language. It isn't intended to operate on its own, but rather as part of another program, the "host". This process is intended to allow a decent amount of easy customisation by the host's end user, by exposing logic in script files. Alternatively, binary files in a custom format can be used as well.
The host will provide all of the extensions needed on a case-by-case basis. Script files have the `.toy` file extension, while binary files have the `.tb` file extension.
```
fn makeCounter() { //declare a function like this
var total: int = 0; //declare a variable with a type like this
fn counter(): int { //declare a return type like this
return ++total;
}
return counter; //closures are explicitly supported
}
var tally = makeCounter();
print tally(); //1
print tally(); //2
print tally(); //3
```
# Nifty Features
* Simple C-like syntax
* Bytecode intermediate compilation
* Optional, but robust type system (including `opaque` for arbitrary data)
* Functions and types are first-class citizens
* Import external libraries
* Fancy slice notation for strings, arrays and dictionaries
* Can re-direct output, error and assertion failure messages
* Open source under the zlib license
# Getting Started
* [Quick Start Guide](geting-started/quick-start-guide)
* [Types](geting-started/types)
* [About Library](geting-started/about-library)
* [Standard Library](geting-started/standard-library)
* [Runner Library](geting-started/runner-library)
* [Game Engine](geting-started/game-engine)
# Deep Dive
* [Theorizing Toy](deep-dive/theorizing-toy)
* [Building Toy](deep-dive/building-toy)
* [Embedding Toy](deep-dive/embedding-toy)
* [Compiling Toy](deep-dive/compiling-toy)
* [Developing Toy](deep-dive/developing-toy)
* [Testing Toy](deep-dive/testing-toy)
* [Roadmap](deep-dive/roadmap)
# Full C API
* [toy_ast_node.h]
* [toy_common.h]
* [toy_compiler.h]
* [toy_interpreter.h]
* [toy_lexer.h]
* [toy_literal_array.h]
* [toy_literal_dictionary.h]
* [toy_literal.h]
* [toy_memory.h]
* [toy_parser.h]
* [toy_refstring.h]
* [toy_scope.h]