From cdffd9b06adf7e1bce7f9b0de10e520773be8e67 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Thu, 18 Mar 2021 15:08:16 -0700 Subject: whirl: :star: --- .gitignore | 1 + book.toml | 6 ++++++ src/SUMMARY.md | 4 ++++ src/introduction.md | 19 +++++++++++++++++++ src/introduction/book.md | 4 ++++ 5 files changed, 34 insertions(+) create mode 100644 book.toml create mode 100644 src/SUMMARY.md create mode 100644 src/introduction.md create mode 100644 src/introduction/book.md diff --git a/.gitignore b/.gitignore index 0067d87..36a7453 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /book/ +/.idea/ diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..f12f7c3 --- /dev/null +++ b/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Fuwn"] +language = "en" +multilingual = false +src = "src" +title = "Whirlsplash" diff --git a/src/SUMMARY.md b/src/SUMMARY.md new file mode 100644 index 0000000..024973c --- /dev/null +++ b/src/SUMMARY.md @@ -0,0 +1,4 @@ +# Summary + +- [Introduction](introduction.md) + - [mdBook](./introduction/book.md) diff --git a/src/introduction.md b/src/introduction.md new file mode 100644 index 0000000..7665ccd --- /dev/null +++ b/src/introduction.md @@ -0,0 +1,19 @@ +# Introduction +Whirlsplash is a [WorldServer](http://dev.worlds.net/private/GammaDocs/WorldServer.html) protocol implementation written in [Rust](https://www.rust-lang.org/). + + + + + + + + +## Purpose +Two *main* reasons; +1. Worlds' official servers are old, slowly deteriorating, and *probably unmaintained*. +2. Worlds is **old**. The shutdown of the servers is inevitable. + +TLDR: To keep Worlds' legacy going for future generations. + +### License +[GNU General Public Liense v3.0](https://github.com/Whirlsplash/whirl/blob/master/LICENSE) diff --git a/src/introduction/book.md b/src/introduction/book.md new file mode 100644 index 0000000..ded757f --- /dev/null +++ b/src/introduction/book.md @@ -0,0 +1,4 @@ +# book +This book was writtin using [mdBook](https://github.com/rust-lang/mdBook). + +For more information about how mdBook works, head over to the aforelinked GitHub repository. -- cgit v1.2.3