From b61f5f1072ec81abd32f7663d3be5a6c6d1de8d0 Mon Sep 17 00:00:00 2001 From: Cricket Date: Mon, 27 Oct 2014 16:18:47 -0400 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3ad684c6..51c0ca45 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ -Chisel-2 -======== +Chisel +======= +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. -A mod originally by AUTOMATIC_MAIDEN to add in aesthetical blocks to Minecraft! +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... + +-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
+ +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. Keep in mind these setup instructions are for IntelliJ IDEA ONLY, not Eclipse. +2. Clone the repository onto your local system. +3. Open a command prompt from the repository folder. +4. Run the command 'gradlew setupDecompWorkspace'. +5. Then, run 'gradlew idea'. +6. Open IntelliJ and point to either the project folder or the build.gradle file. +7. After opening the project in IntelliJ, run 'gradlew genIntellijRuns' in the command terminal you opened earlier. +8. You now have a functional local copy of Chisel, ready to develop on. + +MAKE SURE TO UPDATE YOUR FORK BEFORE MAKING A PULL REQUEST.