From 89799b8673da15408aabb6f4938354ff7d5c9eba Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 25 Jan 2016 20:51:56 -0500 Subject: [PATCH 1/2] 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` From d31025461a4b12452a588bf366912cedcb5fa2ae Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 25 Jan 2016 20:55:04 -0500 Subject: [PATCH 2/2] Notify contributors about makepatch --- CONTRIBUTING.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 474a120..757d0d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,15 @@ # Contribution Guidelines -We will always have a need for developers to help improve Cauldron. Just make sure you follow our guidelines. +We will always have a need for developers to help improve TCPR/KCauldron. Just make sure you follow our guidelines. +**Note**: Use the handy ./makepatch.sh script to create patch files for changes between eclipse/Clean and eclipse/cauldron. Coding and Pull Request Conventions ----------- * We generally follow the Sun/Oracle coding standards. * No tabs; use 4 spaces instead. * No trailing whitespaces. -* No CRLF line endings, LF only; will be converted automatically by git +* No CRLF line endings, LF only; *will be converted automatically by git* * No 80 column limit or 'weird' midstatement newlines. * The number of commits in a pull request should be kept to a minimum (squish them into one most of the time - use common sense!). * No merges should be included in pull requests unless the pull request's purpose is a merge. @@ -22,10 +23,10 @@ If you make changes to or add upstream classes (net.minecraft, net.minecraftforg * Make a separate commit adding the new net.minecraft classes (commit message: "Added x for diff visibility" or so). * Then make further commits with your changes. * Mark your changes with: - * 1 line; add a trailing: `// Cauldron [- Optional reason]` + * 1 line; add a trailing: `// KCauldron [- Optional reason]` * 2+ lines; add - * Before: `// Cauldron start [- Optional comment]` - * After: `// Cauldron end` + * Before: `// KCauldron start [- Optional comment]` + * After: `// KCauldron end` * Keep the diffs to a minimum (*somewhat* important) Tips to get your pull request accepted @@ -38,14 +39,14 @@ Making sure you follow the above conventions is important, but just the beginnin * Provide proper accompanying documentation where appropriate. * Test your code. * Make sure to follow coding best practices. -* Provide a test plugin/mod binary and source for us to test your code with. +* Provide a test plugin/mod binary and socurce for us to test your code with. * Your pull request should link to accompanying pull requests. * The description of your pull request should provide detailed information on the pull along with justification of the changes where applicable. Credits ------- -* [MCP](http://mcp.ocean-labs.de) - permission to use data to make Cauldron. +* [MCP](http://mcp.ocean-labs.de) - permission to use data to make KCauldron. * [Forge](http://www.minecraftforge.net) - mod support. * [CraftBukkit](http://bukkit.org) - plugin support. * [Spigot](http://www.spigotmc.org) - performance optimizations.