Merge pull request #642 from 50Wliu/README

Updated README.md
This commit is contained in:
pahimar 2014-02-26 15:42:58 -05:00
commit 8857269a20

View file

@ -40,7 +40,7 @@ The Java JDK is used to compile EE3.
* Click on `Environment Variables`. * Click on `Environment Variables`.
* Under `System Variables`, click `New`. * Under `System Variables`, click `New`.
* For `Variable Name`, input `JAVA_HOME`. * For `Variable Name`, input `JAVA_HOME`.
* For `Variable Value`, input something similar to `C:\Program Files\Java\jdk1.7.0_45` exactly as shown (or wherever your Java JDK installation is), and click `Ok`. * For `Variable Value`, input something similar to `C:\Program Files\Java\jdk1.7.0_51` exactly as shown (or wherever your Java JDK installation is), and click `Ok`.
* Scroll down to a variable named `Path`, and double-click on it. * Scroll down to a variable named `Path`, and double-click on it.
* Append `;%JAVA_HOME%\bin` EXACTLY AS SHOWN and click `Ok`. Make sure the location is correct; double-check just to make sure. * Append `;%JAVA_HOME%\bin` EXACTLY AS SHOWN and click `Ok`. Make sure the location is correct; double-check just to make sure.
3. Open up your command line and run `javac`. If it spews out a bunch of possible options and the usage, then you're good to go. If not, either try the steps again or check the [FAQ](https://github.com/pahimar/Equivalent-Exchange-3/wiki/Frequently-Asked-Questions). 3. Open up your command line and run `javac`. If it spews out a bunch of possible options and the usage, then you're good to go. If not, either try the steps again or check the [FAQ](https://github.com/pahimar/Equivalent-Exchange-3/wiki/Frequently-Asked-Questions).
@ -59,7 +59,7 @@ Gradle is used to execute the various build tasks when compiling EE3.
2. Windows: Set environment variables for Gradle. 2. Windows: Set environment variables for Gradle.
* Go back to `Environment Variables` and then create a new system variable. * Go back to `Environment Variables` and then create a new system variable.
* For `Variable Name`, input `GRADLE_HOME`. * For `Variable Name`, input `GRADLE_HOME`.
* For `Variable Value`, input something similar to `C:\Gradle-1.10` exactly as shown (or wherever your Gradle installation is), and click `Ok`. * For `Variable Value`, input something similar to `C:\Gradle-1.11` exactly as shown (or wherever your Gradle installation is), and click `Ok`.
* Scroll down to `Path` again, and append `;%GRADLE_HOME%\bin` EXACTLY AS SHOWN and click `Ok`. Once again, double-check the location. * Scroll down to `Path` again, and append `;%GRADLE_HOME%\bin` EXACTLY AS SHOWN and click `Ok`. Once again, double-check the location.
3. Open up your command line and run `gradle`. If it says "Welcome to Gradle [version].", then you're good to go. If not, either try the steps again or check the [FAQ](https://github.com/pahimar/Equivalent-Exchange-3/wiki/Frequently-Asked-Questions). 3. Open up your command line and run `gradle`. If it says "Welcome to Gradle [version].", then you're good to go. If not, either try the steps again or check the [FAQ](https://github.com/pahimar/Equivalent-Exchange-3/wiki/Frequently-Asked-Questions).
@ -67,7 +67,7 @@ Gradle is used to execute the various build tasks when compiling EE3.
Git is used to clone EE3 and update your local copy. Git is used to clone EE3 and update your local copy.
1. Download and install Git [here](http://git-scm.com/download/). 1. Download and install Git [here](http://git-scm.com/download/).
2. *Optional*: Download and install a Git GUI client, such as Github for Windows/Mac, SmartGitHg, TortoiseGit, etc. A nice list is available [here](http://git-scm.com/downloads/guis). * *Optional*: Download and install a Git GUI client, such as Github for Windows/Mac, SmartGitHg, TortoiseGit, etc. A nice list is available [here](http://git-scm.com/downloads/guis).
####Setup EE3 ####Setup EE3
This section assumes that you're using the command-line version of Git. This section assumes that you're using the command-line version of Git.
@ -88,8 +88,9 @@ This section assumes that you're using the command-line version of Git.
* You will generally only have to do this once until the Forge version in `build.properties` changes. * You will generally only have to do this once until the Forge version in `build.properties` changes.
2. Execute `gradle build`. If you did everything right, `BUILD SUCCESSFUL` will be displayed after it finishes. This should be relatively quick. 2. Execute `gradle build`. If you did everything right, `BUILD SUCCESSFUL` will be displayed after it finishes. This should be relatively quick.
* If you see `BUILD FAILED`, check the error output (it should be right around `BUILD FAILED`), fix everything (if possible), and try again. * If you see `BUILD FAILED`, check the error output (it should be right around `BUILD FAILED`), fix everything (if possible), and try again.
3. Go to `mcdev\Equivalent-Exchange-3\build\libs`. 3. Navigate to `mcdev\Equivalent-Exchange-3\build\libs`.
* You should see a `.jar` file named `EquivalentExchange3-0.0.#.jar`, where # is the `build_number` value in `build.properties`. * You should see a `.jar` file named `EquivalentExchange3-1.6.4-0.1.#.jar`, where # is the `build_number` value in `build.properties`.
* NOTE: `null` means that you are missing a `build_number` value in `build.properties` or that your CI environment is set up incorrectly.
4. Copy the jar into your Minecraft mods folder, and you are done! 4. Copy the jar into your Minecraft mods folder, and you are done!
####Updating Your Repository ####Updating Your Repository
@ -109,7 +110,7 @@ So you found a bug in pahimar's code? Think you can make it more efficient? Wa
1. If you haven't already, create a Github account. 1. If you haven't already, create a Github account.
2. Click the `Fork` icon located at the top-right of this page (below your username). 2. Click the `Fork` icon located at the top-right of this page (below your username).
3. Make the changes that you want to and commit them. 3. Make the changes that you want to and commit them.
* If you're making changes locally, you'll have to do `git commit -a` and `git push` in your command line. * If you're making changes locally, you'll have to execute `git commit -a` and `git push` in your command line.
4. Click `Pull Request` at the right-hand side of the gray bar directly below your fork's name. 4. Click `Pull Request` at the right-hand side of the gray bar directly below your fork's name.
5. Click `Click to create a pull request for this comparison`, enter your PR's title, and create a detailed description telling pahimar what you changed. 5. Click `Click to create a pull request for this comparison`, enter your PR's title, and create a detailed description telling pahimar what you changed.
6. Click `Send pull request`, and wait for feedback! 6. Click `Send pull request`, and wait for feedback!
@ -118,12 +119,13 @@ So you found a bug in pahimar's code? Think you can make it more efficient? Wa
EE3 crashes every time? Have a suggestion? Found a bug? Create an issue now! EE3 crashes every time? Have a suggestion? Found a bug? Create an issue now!
1. Make sure your issue hasn't already been answered or fixed. Also think about whether your issue is a valid one before submitting it. 1. Make sure your issue hasn't already been answered or fixed. Also think about whether your issue is a valid one before submitting it.
* Please do not open an issue to ask a question-that is for [pahimar's Twitter](https://twitter.com/pahimar/) or the [forums](http://www.minecraftforum.net/topic/1540010-equivalent-exchange-3).
2. Go to [the issues page](http://github.com/pahimar/Equivalent-Exchange-3/issues). 2. Go to [the issues page](http://github.com/pahimar/Equivalent-Exchange-3/issues).
3. Click `New Issue` right below `Star` and `Fork`. 3. Click `New Issue` right below `Star` and `Fork`.
4. Enter your Issue's title (something that summarizes your issue), and then create a detailed description ("Hey pahimar, could you add/change xxx?" or "Hey, found an exploit: stuff"). 4. Enter your Issue's title (something that summarizes your issue), and then create a detailed description ("Hey pahimar, could you add/change xxx?" or "Hey, found an exploit: stuff").
* If you are reporting a bug report from an unofficial version, make sure you include the following: * If you are reporting a bug report from an unofficial version, make sure you include the following:
* Commit SHA (usually located in a changelog or the jar name itself) * Commit SHA (usually located in a changelog or the jar name itself)
* ForgeModLoader log * ForgeModLoader log
* Server log (if applicable) * Server log if applicable
* Detailed description of the bug * Detailed description of the bug and pictures if applicable
5. Click `Submit new issue`, and wait for feedback! 5. Click `Submit new issue`, and wait for feedback!