From 89799b8673da15408aabb6f4938354ff7d5c9eba Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 25 Jan 2016 20:51:56 -0500 Subject: [PATCH] README minor changes --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2f68c18..bf743ef 100644 --- a/README.md +++ b/README.md @@ -22,48 +22,57 @@ If a mod does not work with KCauldron *specifically*, please check [here](https: **If your issue meets the criteria listed above, please post your issue in the following format:** **Mod Crash** + title: `[Crash] - ` + description: `I am having a problem with and KCauldron. Crash log: . What happens is <...>.` **KCauldron-specific Crash** + title: `[Crash] KCauldron - ` + description: `I am having a problem with KCauldron Build <#>. Crash log: . What happens is <...>.` **KCauldron-specific Feature Proposal** + title: `[Proposal] KCauldron Feature - ` + description: `. . . .` -*This fork is put together by the community. Yive is **not** your personal server issue fixer. He does not know Java nor does he want to learn it.* +*This fork is put together by the community. Yive is NOT your personal server issue fixer. He does not know Java nor does he want to learn it.* ## Contributing -Please read the [guide](https://github.com/TCPR/KCauldron/blob/master/CONTRIBUTING.md) on how to contribute - Cauldron always needs improvements :smile: +Please read the [guide](https://github.com/TCPR/KCauldron/blob/master/CONTRIBUTING.md) on how to contribute - TCPR/KCauldron always needs improvements :smile: ## Downloads You can download the pre-built packages from [here](https://github.com/TCPR/KCauldron/releases). **These unofficial builds are in beta, they may cause issues with your server. You have been warned!** -P.S. Please look at the release notes before downloading. :) +P.S. **PLEASE** look at the release notes before downloading! :smile: ## Build Requirements * Java 8 JDK * `JAVA_HOME` defined on your OS -## Building Cauldron +## Building TCPR/KCauldron * Checkout project * You can use IDE or clone from console: `git clone https://github.com/TCPR/KCauldron.git` -* Init submodules - * Since this project uses two other projects we need to download them as well +* Setup + * Auto: `setup.sh` + * Manual: `git submodule update --init --recursive` -* Start build process +* Build * This process downloads minecraft and apply patches * If you have gradle integration in IDE - you can still use gui + * Auto: `build.sh` + * Manual: `./gradlew setupCauldron jar installBundle` All builds will be in `build/distributions`