Updated README.md

This commit is contained in:
Steven 2023-10-01 06:32:24 -04:00
parent 20586d89c6
commit 6f623fc0fe

View file

@ -3,27 +3,26 @@ Utility Rings
======= =======
A small mod that adds in a ring to turn lava within one block of the player into obsidian A small mod that adds in a ring to turn lava within one block of the player into obsidian
Setup the project to contribute:
## Template Info
Setup Process:
-------- --------
Step 1: Open your command-line and browse to the folder where you extracted cloned your copy of this repository to. Step 1: Open your command-line and browse to the project directory
Step 2: You're left with a choice. Step 2: You're left with a choice.
If you prefer to use Eclipse: If you prefer to use Eclipse:
1. Run the following command: `gradlew genEclipseRuns` (`./gradlew genEclipseRuns` if you are on Mac/Linux) 1. Run the following command to generate the runners for the mod in eclipse (Client,Server,Data,GameTestServer):
2. Open Eclipse, Import > Existing Gradle Project > Select Folder Windows: `./gradlew.bat genEclipseRuns`
or run `gradlew eclipse` to generate the project. Linux/MacOS: `./gradlew genEclipseRuns`
2. Run the following command to create the eclipse project:
Windows: `./gradlew.bat eclipse`
Linux/MacOS: `./gradlew eclipse`
If you prefer to use IntelliJ: If you prefer to use IntelliJ:
1. Open IDEA, and import project. 1. Open IDEA, and import project.
2. Select your build.gradle file and have it import. 2. Import the project by pointing IntelliJ to the build.gradle file.
3. Run the following command: `gradlew genIntellijRuns` (`./gradlew genIntellijRuns` if you are on Mac/Linux) 3. Run the following command to generate the runners for the mod in IntelliJ (Client,Server,Data,GameTestServer):
Windows: `./gradlew.bat genIntellijRuns`
Linux/MacOS: `./gradlew genIntellijRuns`
4. Refresh the Gradle Project in IDEA if required. 4. Refresh the Gradle Project in IDEA if required.
If at any point you are missing libraries in your IDE, or you've run into problems you can If at any point you are missing libraries in your IDE, or you've run into problems you can
@ -38,7 +37,6 @@ license, if you do not agree with it you can change your mapping names to other
build.gradle. For the latest license text, refer to the mapping file itself, or the reference copy here: build.gradle. For the latest license text, refer to the mapping file itself, or the reference copy here:
https://github.com/NeoForged/NeoForm/blob/main/Mojang.md https://github.com/NeoForged/NeoForm/blob/main/Mojang.md
Additional Resources: Credit:
========== =======
Community Documentation: https://docs.neoforged.net/ - Project E for basic iron band texture
NeoForged Discord: https://discord.neoforged.net/