Merge branch 'master' of https://github.com/TCPR/KCauldron

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]`
+        * Before: `// KCauldron start [- Optional comment]`
-        * After: `// Cauldron end`
+        * 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.

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] <Mod Name> - <First line of the exception>`
+
 description:
 `I am having a problem with <Mod Name> and KCauldron. Crash log: <link>. What happens is <...>.`
 
 **KCauldron-specific Crash**
+
 title: `[Crash] KCauldron<build #> - <First line of the exception>`
+
 description:
 `I am having a problem with KCauldron Build <#>. Crash log: <link>. What happens is <...>.`
 
 **KCauldron-specific Feature Proposal**
+
 title: `[Proposal] KCauldron Feature - <Feature Name>`
+
 description:
 `<What this will do>. <Why I want/need it>. <Ideas on how it might be implemented>. <Any helpful links>.`
 
-*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
+* Setup
-  * Since this project uses two other projects we need to download them as well
+  * 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`