aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-02-09 21:43:21 -0800
committerFuwn <[email protected]>2021-02-09 21:43:21 -0800
commitbaced0bf09b2c3df25aa44b3e333fb060b6e27f7 (patch)
tree46f2cdcd5f4553309b7abed1aad32ccf0d381969 /README.md
parentCreate LICENSE (diff)
downloadworldsy-baced0bf09b2c3df25aa44b3e333fb060b6e27f7.tar.xz
worldsy-baced0bf09b2c3df25aa44b3e333fb060b6e27f7.zip
:star:1.0.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0218c37..b699ad7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,32 @@
# worldsy
-A Discord RPC client for Worlds.
+A Discord RPC client for [Worlds](http://worldsonline.com/).
+
+# Why?
+Honestly, I was bored...
+
+I was just sitting at GroundZero, chatting, and I know that there is quite a big Discord server for Worlds and this idea popped into my head and I said "Why the heck not.".
+
+I had to jump through some hoops to get this working as well, I had to learn Tkinter! Python isn't even ONE of my favourite languages so I made this while holding back tears.
+
+### Why Python then?
+Honestly, it was because it the right tool for the right job.
+
+In the future, I might rewrite this in Rust or something but at the moment, it's fine.
+
+Plus, I'd bet there's more Python developers out there than just about any other language so that's a plus.
+
+### How much time did you spend writing this?
+Around three to four hours, without getting up, without looking away... I need help.
+
+## Development
+To get started with this project;
+
+1. Clone the repository.
+2. Install the dependencies via `pip install -r requirements.txt`.
+
+To build an executable, execute `build.bat`.
+
+Note that this is only tested on Windows 10, there is no guarantee that this will work on other operating systems but be my guest in trying.
+
+### License
+[MIT](./LICENSE) \ No newline at end of file