summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorν•œν˜„λΉˆ <41675181+tmvkrpxl0@users.noreply.github.com>2023-12-01 23:42:20 +0900
committerGitHub <noreply@github.com>2023-12-01 15:42:20 +0100
commit6a48e0669d910f4fa1f8ae4131564a7117e1f0db (patch)
treeb216959e1fcf2c386cad160b224f1c13ec58a601 /README.md
parent2bc659b8f12a2772d1541bc69690767694946cd8 (diff)
Update setup process (#17)
Co-authored-by: sciwhiz12 <sciwhiz12@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 3 insertions, 18 deletions
diff --git a/README.md b/README.md
index 8771517..e5e39f1 100644
--- a/README.md
+++ b/README.md
@@ -6,26 +6,11 @@ This template repository can be directly cloned to get you started with a new
mod. Simply create a new repository cloned from this one, by following the
instructions at [github](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
-Once you have your clone, you can initialize your copy.
+Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse.
-Setup Process:
---------
+> **Note**: For IDEs other than Intellij IDEA, you must run the `ideBeforeRun` task first from the terminal (such as `./gradlew ideBeforeRun`) for the run configs to work.
-Step 1: Open your command-line and browse to the folder where you extracted cloned your copy of this repository to.
-
-Step 2: You're left with a choice.
-If you prefer to use Eclipse:
-1. Run the following command: `gradlew genEclipseRuns` (`./gradlew genEclipseRuns` if you are on Mac/Linux)
-2. Open Eclipse, Import > Existing Gradle Project > Select Folder
- or run `gradlew eclipse` to generate the project.
-
-If you prefer to use IntelliJ:
-1. Open IDEA, and import project.
-2. Select your build.gradle file and have it import.
-3. Run the following command: `gradlew genIntellijRuns` (`./gradlew genIntellijRuns` if you are on Mac/Linux)
-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
run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything
{this does not affect your code} and then start the process again.