aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShawn Buckley <shawntbuckley@gmail.com>2015-10-24 13:40:13 -0400
committerShawn Buckley <shawntbuckley@gmail.com>2015-10-24 13:40:13 -0400
commit235588d833ef5952e0a18b03bed56d98ba684749 (patch)
tree51d57032e6ce03eceeaa288c07799c7ddfced7ac
parent3af644dffe93bf6f2e2df54025b0b488c3ca758e (diff)
parentc402ce9404f4710261ea55f02a7f991965ebbccd (diff)
downloadGT5-Unofficial-235588d833ef5952e0a18b03bed56d98ba684749.tar.gz
GT5-Unofficial-235588d833ef5952e0a18b03bed56d98ba684749.tar.bz2
GT5-Unofficial-235588d833ef5952e0a18b03bed56d98ba684749.zip
Merge branch 'master' into experimental
-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.