aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6858b6b..d23d4ed 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,17 @@
# Mundus
-My IT-kariera module 7 (Software development) project. It is built in C# and Gtk# 2.0.
+Mundus is a 2D sandbox openworld RPG. You can explore, destroy, create or fight, the world is your oyster.
-Mundus is a sandbox openworld RPG. You can explore, destroy, create or fight, the world is your oyster.
+This is a project that began as my exam work for IT-kariera Module 7 (Software development) but I plan on working on it long after. It is built in `C#` and `Gtk# 2.0`.
-**Note**: Install [Gtk-Sharp](https://www.mono-project.com/docs/gui/gtksharp/installer-for-net-framework/) to run the executable on _Windows_ and _Linux_ (to run it on Linux, you should use [Mono](https://www.mono-project.com/download/stable/#download-lin)).
+**Note:** This is the `master` branch, here is only the stuff that I want to be in the post-exam versions. To see the project that also has implimented exam requirements, see branch [Requirements](https://github.com/Syndamia/Mundus/tree/Requirements)
+
+## How to play:
+Install the dependencies and run the executable (`.exe` file).
+
+Dependencies:
+ - [Gtk-Sharp](https://www.mono-project.com/docs/gui/gtksharp/installer-for-net-framework/)
+
+Supported platforms:
+ - Windows
+ - Linux (to run it on Linux, you should use [mono](https://www.mono-project.com/download/stable/#download-lin))
+ - MacOS (**hasn't been tested, should work in theory**)