diff --git a/README.md b/README.md index 3885666..d560a71 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,21 @@

- + The Toy Logo

-**This is a work in progress, and is not yet fit for purpose. I hope I can get it to a useable state, but personal issues can often make dedicating myself to a project difficult. Your patience and support is greatly appreciated.** - # Toy v2.x -The Toy Programming Language is an imperative, bytecode-interpreted, embeddable scripting language. Rather than functioning independently, it serves as part of another program, the "host". This design allows for straightforward customization by both the host's developers and end users, achieved by exposing program logic through text files. +The Toy Programming Language is an imperative, bytecode-interpreted, embeddable scripting language. Rather than functioning independently, it serves as part of another program, the "host". This design allows for straightforward customization by both the host's developers and end users, achieved by exposing program logic through external scripts. -This repository holds the reference implementation for Toy version 2.x, written in C. +This repository holds the reference implementation for Toy version 2.x, written in C - alpha testing is currently underway. # Nifty Features -* Simple C-style syntax +* Simple C-like syntax * Intermediate AST and bytecode representations * Strong, but optional type system * First-class functions and closures -* Extensible with imported native code -* Can re-direct output, error and assert failure messages +* Extensible with native C-bindings +* Can re-direct output, error and assertion messages * Open-Source under the zlib license # Syntax diff --git a/docs/book.toml b/docs/book.toml index cdea367..2f48db6 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -2,3 +2,7 @@ title = "The Toy Programming Language" authors = ["Kayne Ruse"] language = "en" + +[output.html] +git-repository-url = "https://github.com/krgamestudios/Toy" +git-repository-icon = "fab-github" \ No newline at end of file diff --git a/docs/src/404.md b/docs/src/404.md new file mode 100644 index 0000000..edca637 --- /dev/null +++ b/docs/src/404.md @@ -0,0 +1 @@ +Nobody here but us chickens! \ No newline at end of file diff --git a/docs/src/README.md b/docs/src/README.md new file mode 100644 index 0000000..f4944a3 --- /dev/null +++ b/docs/src/README.md @@ -0,0 +1,21 @@ +

+ The Toy Logo +

+ +The Toy Programming Language is an imperative, bytecode-interpreted, embeddable scripting language. Rather than functioning independently, it serves as part of another program, the "host". This design allows for straightforward customization by both the host's developers and end users, achieved by exposing program logic through external scripts. + +# Nifty Features + +* Simple C-like syntax +* Intermediate AST and bytecode representations +* Strong, but optional type system +* First-class functions and closures +* Extensible with native C-bindings +* Can re-direct output, error and assertion messages +* Open-Source under the zlib license + +# Further Reading + +This website is under construction - for further info, see the official repository: [https://gitea.krgamestudios.com/krgamestudios/Toy](https://gitea.krgamestudios.com/krgamestudios/Toy), or the GitHub mirror: [https://github.com/krgamestudios/Toy](https://github.com/krgamestudios/Toy). + +An example of Toy in action: [Vampire Toyvivors](https://gitea.krgamestudios.com/krgamestudios/VampireToyvivors). \ No newline at end of file diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 7390c82..2de157b 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,3 +1,3 @@ # Summary -- [Chapter 1](./chapter_1.md) +- [Introduction](./README.md) diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md deleted file mode 100644 index b743fda..0000000 --- a/docs/src/chapter_1.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 1 diff --git a/docs/src/img/toylogo.png b/docs/src/img/toylogo.png new file mode 100644 index 0000000..4a39362 Binary files /dev/null and b/docs/src/img/toylogo.png differ diff --git a/docs/src/img/toypreview.png b/docs/src/img/toypreview.png new file mode 100644 index 0000000..babce69 Binary files /dev/null and b/docs/src/img/toypreview.png differ