From 64e31947a4da5380c4d6915aa6c9b83836daecf6 Mon Sep 17 00:00:00 2001 From: Wliu Date: Thu, 20 Dec 2012 19:48:21 -0500 Subject: [PATCH] Update README.md Updated Java JDK links (u10 came out) Updated for 1.4.6 (MCP/Forge/MC/etc.) Added new section for contributing. Added quick-links to each section (may not work). --- README.md | 39 +++++++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 66187356..75ebe6b0 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,22 @@ Setup MCP was done mostly by the people who update How to Compile for Beginners The Minecraft Forums page can be found [here] (http://www.minecraftforum.net/topic/1540010-equivalent-exchange-3). +[Compiling EE3] (https://github.com/pahimar/Equivalent-Exchange-3#Compiling-Equivalent-Exchange-3) +[Contributing] (https://github.com/pahimar/Equivalent-Exchange-3#Contributing) + ### Compiling Equivalent Exchange 3 IMPORTANT: This is not guaranteed to work as it has not been tested extensively (Linux and Windows tested). ____________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________ #### Prerequisites (Tested for Windows 7 ONLY!) 0. WARNING: Make sure you know EXACTLY what you're doing! It's not any of our faults if your OS crashes, becomes corrupted, etc. -1. Download and install the Java JDK [here](http://www.oracle.com/technetwork/java/javase/downloads/jdk7u9-downloads-1859576.html). Scroll down, accept the Oracle Binary Code License Agreement for Java SE, and download the one pertaining to your OS. +1. Download and install the Java JDK [here] (http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html). Scroll down, accept the Oracle Binary Code License Agreement for Java SE, and download the one pertaining to your OS. * Go to `Control Panel\System and Security\System`, and click on `Advanced System Settings` on the left-hand side. * Click on `Environment Variables`. * Under `System Variables`, click `New`. * For `Variable Name`, input `JAVA_HOME`. - * For `Variable Value`, input something similar to `;C:\Program Files (x86)\Java\jdk1.7.0_09` exactly as shown to the end.(or wherever your Java JDK installation is), and click `Ok`. + * For `Variable Value`, input something similar to `;C:\Program Files (x86)\Java\jdk1.7.0_10` exactly as shown to the end.(or wherever your Java JDK installation is), and click `Ok`. * Scroll down to a variable named `Path`, and double-click on it. - * Append `;C:\Program Files (x86)\Java\jdk1.7.0_09\bin` (or wherever your Java JDK installation is \bin), and click `Ok`. + * Append `;C:\Program Files (x86)\Java\jdk1.7.0_10\bin` (or wherever your Java JDK installation is \bin), and click `Ok`. 2. Download Apache Ant [here] (http://ant.apache.org). * Unzip the files anywhere you want, eg `C:\Program Files (x86)\Ant`. * Again, go to `Environment Variables` just like you did for the Java JDK. @@ -34,11 +37,11 @@ ________________________________________________________________________________ #### Setup MCP (Linux and Windows 7 tested) -1. Download the latest version of MCP from [here] (http://mcp.ocean-labs.de/index.php/MCP_Releases), e.g. mcp723.zip. Install MCP dependencies as listed on the website if neccessary. +1. Download the latest version of MCP from [here] (http://mcp.ocean-labs.de/index.php/MCP_Releases), e.g. mcp725.zip. Install MCP dependencies as listed on the website if neccessary. 2. Inside `mcdev`, create a directory named `mcp` and unzip the MCP .zip file into it. * To verify, check if a file named `CHANGELOG` exists inside `mcp`. -3. Download the latest forge **source** for Minecraft 1.4.5 and unzip it into `mcp`. You need at least Forge 6.4.0, best way is to get it from [here] (http://files.minecraftforge.net/). +3. Download the latest forge **source** for Minecraft 1.4.6 and unzip it into `mcp`. You need at least Forge 6.4.0, best way is to get it from [here] (http://files.minecraftforge.net/). * To verify, check if a application named `install.sh` exists. 4. Execute `install.sh` (Linux and Mac) or `install.cmd` (Windows), both found in `mcdev\mcp\forge`. On Linux you might have to `chmod +x` `install.sh` before you can execute it. On some system configurations you need to execute `install.sh` from within the `forge` directory whereas on others it doesn't matter. Just check the output for error messages to find out what you need to do. @@ -65,7 +68,7 @@ ________________________________________________________________________________ * `dir.development=../../` * `dir.share=Shared` (or what you want it to be-optional) * `dir.release=Releases` (what you want it to be) - * `release.minecraft.version=1.4.5` (as of 12/02) + * `release.minecraft.version=1.4.6` (as of 12/20) * `release.mod.version=pre1d` (or whatever version # want it to be) 5. [FOR WINDOWS] Open up `cmd` by typing `cmd` in Run. @@ -73,7 +76,7 @@ ________________________________________________________________________________ 7. Execute `ant release`. This will generally take around 5-15 minutes, depending on your computer. If you've done everything right, `BUILD SUCCESSFUL` is displayed after it finishes. * If you see `BUILD FAILED`, check the error output (it should be right around `BUILD FAILED`), fix everything, and try again. -8. Go to `mcdev\source\Equivalent-Exchange-3\Releases\1.4.5\pre1d` (This might be different according to what you put in build.properties). +8. Go to `mcdev\source\Equivalent-Exchange-3\Releases\1.4.6\pre1d` (This might be different according to what you put in build.properties). * You should see a .jar named `ee3-universal-pre1d.jar` (Again, might be different). 9. Copy the jar into your Minecraft mods folder, and play Minecraft! @@ -88,4 +91,24 @@ ________________________________________________________________________________ 5. Click `Sync`, and wait for it to finish. -6. Re-compile (or move it to `mcdev\source` then re-compile, depending on what you did.) \ No newline at end of file +6. Re-compile (or move it to `mcdev\source` then re-compile, depending on what you did.) + +###Contributing +___________________________________________________________________________________________________________________________________________________ +#### Submitting a PR +So you found a bug in pahimar's code? Think you can make it more efficient? Want to help in general? Great! + +1. If you haven't already, create a Github account. +2. Click `Fork` at the top-right of this page (below your username) +3. Make the changes that you want to. +4. Click `Pull Request` at the top-middle of the page (left of your fork's name, to the right of `Watch` and `Fork`). +5. Enter your PR's title, and create a detailed description telling pahimar what you changed. +6. Click `Send pull request`, and you're done! + +#### Creating an Issue +So, maybe you have no idea what Java is, but you **do** know that EE3 crashes each time you enter a world. Or, maybe you have an idea that you want pahimar to implement. No problem! Just create an issue instead of submitting a PR. + +1. Go to [the issues page] (http://github.com/pahimar/Equivalent-Exchange-3/issues). +2. Click `New Issue` right below `Graphs`. +3. Enter your Issue's title (like EE3 crashes when using Minium Stone), and then create a detailed description telling pahimar what happened (like "When trying to use a minium stone, EE3 crashes. Here's the error report: [link]). +4. Click `Submit new issue`, and you're done!