From a311e87ccdbab1052c8c5fb399e01ce799999dd1 Mon Sep 17 00:00:00 2001 From: Vaern <90118520+Vaern@users.noreply.github.com> Date: Fri, 16 Sep 2022 00:15:24 -0700 Subject: [PATCH] Update README.md --- README.md | 38 +++++++++++++++++++++++++++++++++----- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9f6813dc5..85bc0819a 100644 --- a/README.md +++ b/README.md @@ -40,17 +40,45 @@ Please note that these installation instructions are assuming you're running Mic ## Contributing If you want to make some changes to the mod, follow this guide: -1. Follow steps 1-4 from *Building from source* section -2. Setup forge decompilation workspace +1. Follow steps 1-2 from *Building from source* section +2. Create a directory where the repository will reside, using a name that is not "Hbm-s-Nuclear-Tech-GIT" +3. Download the forge src from [here](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.7.10.html) and extract it into the directory. +4. Download the source code: + * Using Git Bash, enter wherever your directory is located: +```bash + cd $HOME/Downloads +``` + * Download the source code: +```bash + git clone https://github.com/HbmMods/Hbm-s-Nuclear-Tech-GIT.git + ``` + * Move or copy every file within the new folder into your directory, making sure to overwrite any files. + * Feel free to delete the remaining folder and rename your directory (such as "Hbm-s-Nuclear-Tech-GIT") +5. Enter the source directory +```bash + cd Hbm-s-Nuclear-Tech-GIT +``` +6. Setup forge decompilation workspace ```bash ./gradlew setupDecompWorkspace ``` -3. (OPTIONAL, but needed if you use eclipse) Generate eclipse files +### Necessary for Eclipse users +7. Generate eclipse files ```bash ./gradlew eclipse ``` -4. Open up the project directory in eclipse using *Open existing project from file system* -5. Code! +8. Switch to the **eclipse** folder inside your directory as a workspace. +9. If necessary, make sure that Eclipse is using the JDK8. + * On Linux, enter Windows>Preferences>Java>Installed JREs. + * Click search to navigate to /usr/lib/jvm and open it. Select the Java 8 JDK (e.g., java-8-openjdk). + * Afterwards, enter Execution Environment, select JavaSE-1.8, and select the jre listed as a **[perfect match]** + * On Windows, you may need to set your JAVA_HOME. + * Search for Environment Variables and click Edit the System Environment Variables. + * Click Environment Variables. Click new under System Variables. + * Enter **JAVA_HOME** under Variable Name and enter the path to your JDK 8 under Variable Value (e.g., C:\Program-Files\Java\jdk1.8.0_102). + * In Eclipse, now enter Windows>Preferences>Java>Installed JREs. + * Click **Add Standard VM**; in the JRE home, navigate to the directory where the JDK is installed, then click finish and select it. +10. Code! # License This software is licensed under the GNU Public License version 3. In short: This software is free, you may run the software freely, create modified versions, distribute this software and distribute modified versions, as long as the modified software too has a free software license. You win this round, Stallman. The full license can be found in the `LICENSE` file.