Skip to content

Commit cd84683

Browse files
committed
update readme for project starter
1 parent 21f7c2c commit cd84683

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,16 @@ This build script was heavily inspired by the build script created by GT New Hor
2929
And many more to come! And of course, all of these features are toggleable via an option in `gradle.properties`.
3030

3131
## How to Install (New Project)
32-
Coming soon!
32+
- Download the latest **starter.zip** release from [here](https://github.com/GregTechCEu/Buildscripts/releases) and extract into your project directory
33+
- Import into your IDE (we recommend IntelliJ IDEA, as it has the best support for modded Minecraft)
34+
- Choose a license for your code
35+
- Ensure your project is initialized in git. For example, you can run `git init; git commit --message "initial commit"`
36+
- Replace placeholder values, such as `gradle.properties`, package/class names for your `src/main` directory, etc.
37+
- Run `./gradlew setupDecompWorkspace`
38+
- You are good to go! You can now run the `runClient` run configuration or run `./gradlew runClient` to launch the game
3339

3440
## How to Install (Existing Project)
35-
- Download the latest master as a zip file from [here](https://github.com/GregTechCEu/Buildscripts/archive/refs/heads/master.zip)
41+
- Download the latest **migration.zip** release from [here](https://github.com/GregTechCEu/Buildscripts/releases)
3642
- Rename your `build.gradle` file to `build.gradle.old`
3743
- Copy the [`build.gradle`](https://github.com/GregTechCEu/Buildscripts/blob/master/build.gradle), [`dependencies.gradle`](https://github.com/GregTechCEu/Buildscripts/blob/master/dependencies.gradle), and [`repositories.gradle`](https://github.com/GregTechCEu/Buildscripts/blob/master/repositories.gradle) files from this zip to your project
3844
- Copy the [`settings.gradle`](https://github.com/GregTechCEu/Buildscripts/blob/master/settings.gradle) file from this zip to your project and replace your current one

0 commit comments

Comments
 (0)