diff --git a/.gitignore b/.gitignore index 8dc84b5..9e4abbf 100644 --- a/.gitignore +++ b/.gitignore @@ -20,7 +20,6 @@ target/ *.war *.nar *.ear -*.zip *.tar.gz *.rar diff --git a/Basic_Crop_Pack.zip b/Basic_Crop_Pack.zip new file mode 100644 index 0000000..7de0282 Binary files /dev/null and b/Basic_Crop_Pack.zip differ diff --git a/README.md b/README.md index 125b842..1efd334 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,70 @@ # Custom-Crops StardewValley Like Farming System -### How to buy +### Support the developer https://afdian.net/@xiaomomi https://polymart.org/resource/customcrops.2625 -### How to compile +## How to build -./gradlew build and get the jar in /target folder +### Windows + +#### Command Line +Install JDK 17 and set the JDK installation path to JAVA_HOME as an environment variable.\ +Start powershell and change directory to the project folder.\ +Execute ".\gradlew build" and get the jar at /target/CustomFishing-plugin-version.jar. + +#### IDE +Import the project and execute gradle build action. + +## Use CustomFishing API + +### Maven + +``` + + + jitpack + https://jitpack.io/ + + +``` +``` + + + com.github.Xiao-MoMi + Custom-Crops + {LATEST} + provided + + +``` +### Gradle (Groovy) + +``` +repositories { + maven { url 'https://jitpack.io' } +} +``` +``` +dependencies { + compileOnly 'com.github.Xiao-MoMi:Custom-Crops:{LATEST}' +} +``` +### Gradle (Kotlin) + +``` +repositories { + maven("https://jitpack.io/") +} +``` +``` +dependencies { + compileOnly("com.github.Xiao-MoMi:Custom-Crops:{LATEST}") +} +``` ### API Guide ```access transformers