aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShawnBuckley <ShawnBuckley@users.noreply.github.com>2015-10-24 13:38:16 -0400
committerShawnBuckley <ShawnBuckley@users.noreply.github.com>2015-10-24 13:38:16 -0400
commitc402ce9404f4710261ea55f02a7f991965ebbccd (patch)
tree616518f5ee60e4e177cef81c097f3691d23dd6d8
parentff95d2e31dc66db3fa6a31326ce269e6b484d637 (diff)
downloadGT5-Unofficial-c402ce9404f4710261ea55f02a7f991965ebbccd.tar.gz
GT5-Unofficial-c402ce9404f4710261ea55f02a7f991965ebbccd.tar.bz2
GT5-Unofficial-c402ce9404f4710261ea55f02a7f991965ebbccd.zip
Create README.md
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..db772d4f1f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+GT5-Unofficial
+===
+
+## About
+
+GT5-Unofficial is a decompiled and modified version of GT5.07.07. The goal of the mod is to maintain and extend the end game of GT5.
+
+## Downloads
+
+Builds can be found on the [IC2 Forums](http://forum.industrial-craft.net/index.php?page=Thread&threadID=11488).
+
+## Installation
+
+GT5U requires IndustrialCraft2-experimental. Version 2.2.780-experimental or newer is recommended.
+Forge versions 1428-1480 are known to break multiplayer. 1481 or newer are recommended.
+Place the downloaded jar file into your mods/ folder.
+
+## Issues
+
+Please report any issues you to find the issue tracker on this repository. Include as much information as possible including as version and steps to reproduce.
+
+## Contribution
+
+Please do! However, please take a note of current issues and what is currently being worked on.