From 6a48e0669d910f4fa1f8ae4131564a7117e1f0db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=ED=95=9C=ED=98=84=EB=B9=88?= <41675181+tmvkrpxl0@users.noreply.github.com> Date: Fri, 1 Dec 2023 23:42:20 +0900 Subject: [PATCH] Update setup process (#17) Co-authored-by: sciwhiz12 --- README.md | 21 +++------------------ 1 file 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.