aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorchill <chill.gtnh@outlook.com>2023-04-19 09:55:06 +0200
committerGitHub <noreply@github.com>2023-04-19 09:55:06 +0200
commit02728021c669e70916605b7cbb43641818204147 (patch)
tree329db0d484e36e722de9d9befdb20f05bdb9e023
parent72e5e61e9c3116435a4de6d7bc94d2cd66e20f89 (diff)
downloadGT5-Unofficial-02728021c669e70916605b7cbb43641818204147.tar.gz
GT5-Unofficial-02728021c669e70916605b7cbb43641818204147.tar.bz2
GT5-Unofficial-02728021c669e70916605b7cbb43641818204147.zip
Explain how to import GT5 (#1892)
* Add info on how to build GT5-Unofficial It might be not the only way to do it correctly, but it is still better than nothing because it reduces the amount of questions to the devs on how to build this repository without errors. * Wrap the code of Readme.md at 120 characters This will allow to read the code on most devices without horizontal scrolling.
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index c82cd0cdbf..968c8f1738 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,8 @@ 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. This version has been heavily modified for use with the GTNH modpack.
+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.
## Downloads
@@ -17,15 +18,21 @@ Place the downloaded jar file into your mods/ folder. A number of other mods may
## 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.
+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.
+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.
+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