aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 45 insertions, 8 deletions
diff --git a/README.md b/README.md
index d800cb789c..968c8f1738 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,48 @@
-# KekzTech
-A Minecraft mod for the 1.7.10 modpack GTNH.
-No compatibility outside GTNH guaranteed.
+GT5-Unofficial
+===
-My mod adds Solid Oxide Fuel Cells to turn gas fuels into electricity and steam, a multi tank that can store up to 25 different fluids in one structure, and a nuclear reactor in the future.
+## About
-Solid Oxide Fuel Cell MK1 and MK2:
-![picture of Solid Oxied Fuel Cells, tier 1 and 2](https://github.com/GTNewHorizons/KekzTech/blob/master/screenshots/SOFC_Display.jpeg?raw=true)
+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. This version has been heavily modified for use with the GTNH modpack.
-Multi Tank:
-![picture of multi tank](https://github.com/GTNewHorizons/KekzTech/blob/master/screenshots/TFFT_Display.jpeg?raw=true)
+## Downloads
+
+Builds can be found on the [GTNH Jenkins Server](http://jenkins.usrv.eu:8080/job/Gregtech-5-Unofficial/).
+
+## Installation
+
+GT5U requires IndustrialCraft2-experimental. Version 2:2.2.828-experimental is recommended.
+Forge versions 1428-1480 are known to break multiplayer. 1614 is recommended.
+Place the downloaded jar file into your mods/ folder. A number of other mods may be required, see dependencies.gradle
+
+## Issues
+
+Please report any issues you to find to the main GTNH issue tracker. Include as much information as possible including
+as version and steps to reproduce.
+
+## Contribution
+
+Please do! However, please take a note of
+[current issues](https://github.com/GTNewHorizons/GT-New-Horizons-Modpack/issues) and what is currently being worked on.
+
+It is suggested to run `./gradlew build` inside your cloned repository before importing it to your IDE. This will reduce
+the chance of strange errors.
+
+## Attribution
+
+Some textures/ideas have been taken from future versions of GT and texture pack authors for GTNH. Credit goes to Jimbno
+for the UU-Tex texture pack and its contributions to the base pack here: https://github.com/Jimbno/UU-Tex.
+
+## License
+
+GT5-Unofficial is free software: you can redistribute it and/or modify it under the terms of the
+GNU Lesser General Public License as published by the Free Software Foundation, either version 3
+of the License, or (at your option) any later version.
+
+GT5-Unofficial is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with GT5-Unofficial.
+If not, see <http://www.gnu.org/licenses/>.