aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-03-18 15:08:16 -0700
committerFuwn <[email protected]>2021-03-18 15:08:16 -0700
commitcdffd9b06adf7e1bce7f9b0de10e520773be8e67 (patch)
tree6a4c61eb8533999e75c4c1e0965b02e3150833d2 /src
parentetc: create .gitignore (diff)
downloadbook-cdffd9b06adf7e1bce7f9b0de10e520773be8e67.tar.xz
book-cdffd9b06adf7e1bce7f9b0de10e520773be8e67.zip
whirl: :star:
Diffstat (limited to 'src')
-rw-r--r--src/SUMMARY.md4
-rw-r--r--src/introduction.md19
-rw-r--r--src/introduction/book.md4
3 files changed, 27 insertions, 0 deletions
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/).
+
+<a href="https://discord.com/invite/8hn6padWF6" title="Discord">
+ <img src="https://img.shields.io/discord/821938182274154506">
+</a>
+<a href="./LICENSE" title="License">
+ <img src="https://img.shields.io/github/license/Whirlsplash/whirl">
+</a>
+
+## 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.