diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..588d2d84 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +Contributing +============ +___ +Setting up a Development Environment +------------------------------------ +Chisel is open-source under the GPL v2 license. As a result, you may contribute to the development of the mod via pull requests. + +To set up the mod as to allow you to make changes, do the following: + +1. Clone the repository onto your local system. +2. Open a command prompt from the repository folder. +3. Run the command `gradlew setupDecompWorkspace` (using `./gradlew` if on Mac/Linux) + +*The next steps vary based on what IDE you wish to use* + +### IntelliJ IDEA +1. Run `gradlew idea`. +2. Open IntelliJ and point to either the project folder or the build.gradle file. +3. After opening the project in IntelliJ, run `gradlew genIntellijRuns` in the command terminal you opened earlier. + +### Eclipse + +1. Run `gradlew eclipse`. +2. Open Eclipse and import the folder as a project. + +You now have a functional local copy of Chisel, ready to develop on. + +___ +Formatting +---------- + +When coding for Chisel 2, please use the provided [formatter settings](eclipseFormat.xml) to format your code. Poorly formatted code, or PRs which reformat existing code will likely not be accepted. diff --git a/README.md b/README.md index a905f5f3..95dc75ae 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,35 @@ -Chisel +Chisel 2 ======= -Chisel is a mod for Minecraft which adds aesthetic blocks to the game through the use of a chisel. Originally created by -AUTOMATIC_MAIDEN, it was ported to Minecraft 1.7.2 by asie, and maintained by Pokefenn during 1.7.10 and now maintained by Cricket. +Chisel is a mod for Minecraft which adds aesthetic blocks to the game through the use of a chisel. + +Originally created by +AUTOMATIC_MAIDEN, it was ported to Minecraft 1.7.2 by asie, and maintained by Pokefenn during 1.7.10. + +The second iteration of the mod contains loads of new blocks, new features like the autochisel and chisel modes, and lots of bugfixes. + +It is maintained by [Cricket](github.com/TheCricket), [tterrag](github.com/tterrag1098), [warlordjones](github.com/warlordjones), [Drullkus](github.com/Drullkus) (Artist), and [CptSpaceToaster](github.com/CptSpaceToaster). Pull Requests --------------- -If you wish to create a pull request with an awesome new feature, a language translation or even a bug fix. That's cool but please push to the correct branch which is dev. That is the working branch. Master is for releases only. + +Pull requests with new features, translations, and bufixes are very welcome. Please make sure to always submit PRs against the ***dev*** branch, not master. + +Do not make PRs that are solely formatting or other aesthetic things. + +If your PR is going to take a lot of work, it may be best to make an issue so we can discuss the feature before you create it. + +See the [CONTRIBUTING](CONTRIBUTING.md) file for more details. Issue Reporting ---------------- -If you wish to report an issue with the mod, please submit one to the issue tracker in this repository. When creating an -issue, please be sure to include... +If you wish to report an issue with the mod, please submit one to the issue tracker in this repository. When creating an +issue, please be sure to include: --the version of Chisel you are using
--the version of Forge you are using
--the crash report (preferrably via Pastebin) generated by the error
--depending on the error, an image of the problem
+- The version of Chisel 2 you are using ("latest" is not an acceptable version) +- The version of Forge you are using +- If applicable, the crash report (preferrably via [Pastebin](http://pastebin.com/)). generated by the error +- Depending on the error, an image of the problem -Contributing -------------- -Chisel is open-source under the GPL v2 license. As a result, you may contribute to the development of the mod via pull requests. -To set up the mod as to allow you to make changes, do the following: - -1. Clone the repository onto your local system. -2. Open a command prompt from the repository folder. -3. 3. Run the command 'gradlew setupDecompWorkspace' if on a Windows, 'bash gradlew setupDecompWorkspace' on a Mac, and 'gradle setupDecompWorkspace' if you have Gradle installed, on any OS. - -*The next steps vary based on what IDE you wish to use* - -### IntelliJ IDEA -4. Run 'gradlew idea'. -5. Open IntelliJ and point to either the project folder or the build.gradle file. -6. After opening the project in IntelliJ, run 'gradlew genIntellijRuns' in the command terminal you opened earlier. - -### Eclipse - -4b. Run 'gradlew eclipse' if on a Windows, 'bash gradlew eclipse' on a Mac, and 'gradle eclipse' if you have Gradle installed, on any OS. - -5b. Open Eclipse and point it to the folder named 'eclipse' within the folder. - -You now have a functional local copy of Chisel, ready to develop on. - - -MAKE SURE TO UPDATE YOUR FORK BEFORE MAKING A PULL REQUEST. - -Jenkins +Development Builds ---------------- http://coloredlightscore.us.to:8080/job/Chisel-2%20v1.7.10-Dev/