From 1f67121bb87fa28c03cabc6a17f4415aa5b5d0bf Mon Sep 17 00:00:00 2001 From: Trcx Date: Wed, 18 Mar 2015 00:06:51 -0500 Subject: [PATCH] Create README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..55198f2 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Swapper +Just a mod that auto swaps tools + +##Development +Install Forge as usual, and setup your IDE as with any other Forge project. + +##Compile from Source +* Setup: Run [gradle]in the repository root: `gradlew[.bat] [setupDevWorkspace|setupDecompWorkspace] [eclipse|idea]` +* Build: Run [gradle]in the repository root: `gradlew[.bat] build' +* If obscure Gradle issues are found try running 'gradlew clean' and 'gradlew cleanCache' + +##Issue reporting +Please include the following: + +* Minecraft version +* Swapper version +* Forge version/build +* Versions of any mods potentially related to the issue +* Any relevant screenshots are greatly appreciated. +* For crashes: + * Steps to reproduce + * ForgeModLoader-client-0.log (the FML log) from the root folder of the client + +##Licenses +The Project is under the MIT License. Do what you want with the code, but under no circumstances am I liable.