Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
progwml6 committed Feb 3, 2014
1 parent 623de7c commit dc97407
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
@@ -0,0 +1,34 @@
#[Tinkers' Mechworks](http://www.minecraftforum.net/topic/1659892-tinkers-construct/)

##Development
Install Forge as usual, and setup your IDE as with any other Forge project.

##Compile from Source
Note: Git MUST be installed and in the system path to use our scripts.
* 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' or/and 'gradlew cleanCache'

##Issue reporting
Please include the following:

* Minecraft version
* Tinkers Mechworks version
* Tinkers Construct 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
Most code is licensed under the [MIT License](http://opensource.org/licenses/MIT).

Textures and binaries are licensed under [Creative Commons 3](http://creativecommons.org/licenses/by/3.0/).

Any modpack which uses Tinkers' Mechworks takes **full** responsibility for user support queries. For anyone else, we only support official builds from the main CI server, not custom built jars. We also do not take bug reports for outdated builds of Minecraft.

If you have queries about any license or the above support restrictions, please drop by our IRC channel, #TinkersConstruct on irc.esper.net

Any alternate licenses are noted where appropriate.

0 comments on commit dc97407

Please sign in to comment.