diff --git a/README.md b/README.md index be12cc93..7763a723 100644 --- a/README.md +++ b/README.md @@ -12,66 +12,67 @@ IMPORTANT: Please report any issues you have, there might be some problems with *** #### Windows Prerequisites 1. **WARNING: Make sure you know EXACTLY what you're doing! It's not any of our faults if your OS crashes, becomes corrupted, etc.** -2. Download and install the Java JDK (If you have a 64bit OS, install the 64bit version) [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 it. +2. 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 it. (If you have a 64-bit OS, please download the 64-bit version.) * 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\Java\jdk1.7.0_40` 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_40` 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 `;%JAVA_HOME%\bin`, and click `Ok`. 3. Download Apache Ant [here](http://ant.apache.org). - * Unzip the files anywhere you want, eg `C:\Program Files\Ant`. + * 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. * Under `System Variables`, click `New`. * For `Variable Name`, input `ANT_HOME`. * For `Variable Value`, input `C:\Ant\apache-ant-1.9.2` (or your Ant directory\apache-ant-1.9.2). * Scroll down to `Path`, and double-click on it. * Append `;%ANT_HOME%\bin` exactly as shown to the end. -4. Download and install Github [here](http://windows.github.com/) (Windows) NOTE: The Github application is optional, you can use whatever you want, e.g. TortoiseGit +4. Download and install Github [here](http://windows.github.com/) (Windows) NOTE: This Github application is optional, you can use whatever you want, e.g. TortoiseGit * Create an account. - * Scroll to the top of this page, login at the top-right, and then click `Clone to Windows/Mac` at the bottom of the right-hand toolbar. + * Scroll to the top of this page, login at the top-right, and then click `Clone to Windows` at the bottom of the right-hand toolbar. * You should see Github flash and `pahimar/Equivalent-Exchange-3` appear. (The local repository on Windows defaults to `C:\Users\(username)\Documents\GitHub\Equivalent-Exchange-3`, you can change it if you want but then you have to find it again on Github). 5. Create an empty directory for EE3 development. This directory is referenced as `mcdev` from now on. It can be where you cloned EE3, but it'll be a little messy. #### Linux Prerequisites -1. Make sure you have the latest Java JDK installed +1. Make sure you have the latest Java JDK installed. To install manually, go [here](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html). Otherwise, install from the package manager or the terminal (listed). * In Gentoo, `emerge dev-java/oracle-jdk-bin` * In Archlinux, `pacman -S jdk7-openjdk` * In Ubuntu, `apt-get install openjdk7-jdk` * In Debian, `apt-get install openjdk-7-jdk` * In Fedora, `yum install java-1.7.0-openjdk` - * etc. -2. Install Apache Ant + * If your distribution is not listed, follow the instructions specific to your package manager. +2. Install Apache Ant. To install manually, go [here](http://ant.apache.org). * In Gentoo, `emerge dev-java/ant` * In Archlinux, `pacman -S apache-ant` * In Ubuntu/Debian, `apt-get install ant` * In Fedora, `yum install ant` - * etc. -3. Install Git + * If your distribution is not listed, follow the instructions specific to your package manager. +3. Install Git. To install manually, go [here](http://git-scm.com/). * In Gentoo, `emerge dev-vcs/git` * In Archlinux, `pacman -S git` * In Ubuntu/Debian, `apt-get install git` * In Fedora, `yum install git` - * etc. -4. Open your shell and move to a convenient directory, then run `git clone https://github.com/pahimar/Equivalent-Exchange-3`. This will download the repository. + * If your distribution is not listed, follow the instructions specific to your package manager. +4. Open your shell and move to a convenient directory, then run `git clone https://github.com/pahimar/Equivalent-Exchange-3.git`. This will download the repository. 5. Create an empty directory for EE3 development. This directory is referenced as `mcdev` from now on. It can be where you cloned EE3, but it'll be a little messy. #### Mac Prerequisites 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 it. (Mac OS X comes with the JRE, but it is often Java 6, which does not always work.) -2. Apache Ant should already be installed on your computer. To check, go into the Terminal, and type `ant --version`. It should return a version string. If you get a "command not found" error, it's not installed. -3. Download and install Github for Mac OSX (10.7+) [here](http://mac.github.com/) (Mac) NOTE: The Github application is optional, you can use whatever you want. +2. Apache Ant should already be installed on your computer. To check, go into Terminal, and type `ant --version`. It should return a version string. If you get a "command not found" error, it's not installed. +3. Download and install Github for Mac OSX (10.7+) [here](http://mac.github.com/) NOTE: The Github application is optional, you can use whatever you want. * Create an account. - * Scroll to the top of this page, login at the top-right, and then click `Clone to Windows/Mac` at the bottom of the right-hand toolbar. - * You should see Github flash and `pahimar/Equivalent-Exchange-3` appear. (The local repository on Windows defaults to `C:\Users\(username)\Documents\GitHub\Equivalent-Exchange-3`, you can change it if you want but then you have to find it again on Github). + * Scroll to the top of this page, login at the top-right, and then click `Clone to Mac` at the bottom of the right-hand toolbar. + * You should see Github flash and `pahimar/Equivalent-Exchange-3` appear. (The local repository on Windows defaults to `/Users/[username]/github/Equivalent-Exchange-3/`. To change it, change the "Local Path") 5. Create an empty directory for EE3 development. This directory is referenced as `mcdev` from now on. It can be where you cloned EE3, but it'll be a little messy. #### Setup MCP -1. Download the latest version of Forge source from here: http://files.minecraftforge.net -2. Inside `mcdev`, unzip the forge source zip - * You should get a folder named "forge" inside "mcdev" containing the forge patches, and licenses. -4. Execute `install.sh` (Linux and Mac) or `install.cmd` (Windows), both found in `mcdev\forge`. On Linux you might have to `chmod +x install.sh` before you can execute it. +NOTE: You may skip to "Setup EE3" if you want to let EE3 download and set up MCP for you. Simply run `ant forge-install`, then `ant build`. +1. Download the latest version of Forge source from [here](http://files.minecraftforge.net) +2. Inside `mcdev`, unzip the zip file. + * You should get a folder named "forge" inside "mcdev" containing the forge patches and licenses, etc. +3. Execute `install.sh` (Linux and Mac) or `install.cmd` (Windows), both found in `mcdev\forge`. On Linux you might have to `chmod +x install.sh` before you can execute it. * This will take some time, be patient. #### Setup EE3 @@ -85,31 +86,33 @@ IMPORTANT: Please report any issues you have, there might be some problems with \-forge \-mcp \-jars + \-CHANGELOG, etc. \-install.cmd \-install.sh + \-etc. \-source \-Equivalent-Exchange-3 \-EE3's files (should have build.xml). *** 4. Inside `Equivalent-Exchange-3`, create a new file called `environment.properties`. - * Open it up with any text editor, and type into it the following (change the base_location to wherever you have "mcdev."): + * Open it up with any text editor, and type the following into it (change `base_location` to wherever you have "mcdev". All of the variables are changeable for your setup.): * `base_location=C:/mcdev/` * `source_location=${base_location}/source/Equivalent-Exchange-3` * `mcp_location=${base_location}/forge/mcp` * `release_location=${base_location}/source/Equivalent-Exchange-3/Releases` - * You may also edit the build.properties to show what the build string is and what minecraft version you are building for. + * You may also edit the build.properties to change the build string (`mod_version` and `build_number`), and the Minecraft and Forge version you are building for (`forge_version` is only used when running `ant forge-install`) * `minecraft_version=1.6.4` * `forge_version=9.11.0.883` * `mod_version=pre2` * `build_number=1` 5. Open up your OS's command line (Command Prompt in Windows, Terminal in Linux and Mac). 6. Navigate to `mcdev\source\Equivalent-Exchange-3` by executing `cd mcdev's location\source\Equivalent-Exchange-3`. -7. Execute `ant build`. 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. +7. Execute `ant build`. (If you want EE3 to setup Forge, run `ant forge-install` first.) 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 (if possible), and try again. 8. Go to `mcdev\source\Equivalent-Exchange-3\Releases\MC 1.6.4\pre2`. * You should see a `.jar` file named `ee3-universal-pre2.jar`. -9. Copy the jar into your Minecraft mods folder, and play Minecraft (If you have forge installed, of course). +9. Copy the jar into your Minecraft mods folder, and play Minecraft (If you have Forge installed on your client). #### Updating Your Repo (For Windows/Mac) 1. Check to see if pahimar updated EE3 since you last compiled. If he did, follow these instructions. @@ -121,9 +124,9 @@ IMPORTANT: Please report any issues you have, there might be some problems with #### Updating Your Repo (For Linux) 1. Check to see if pahimar updated EE3 since you last compiled. If he did, follow these instructions. -2. cd to your repository -3. run "git pull" -4. Re-compile (or move it to `mcdev\source` then re-compile, depending on what you did.) +2. Navigate to the repository location. +3. Run `git pull` in Terminal. +4. Re-compile (or move it to `mcdev\source` then re-compile, depending on what you did). ###Contributing *** @@ -133,7 +136,7 @@ So you found a bug in pahimar's code? Think you can make it more efficient? Wa 1. **IMPORTANT: PAHIMAR DOES *NOT* WANT ANY** `build.xml` **CHANGES, UNLESS it fixes up something broken** (See [Pull Request #90](https://github.com/pahimar/Equivalent-Exchange-3/pull/90)). 2. If you haven't already, create a Github account. 3. Click the `Fork` icon at the top-right of this page (below your username). -4. Make the changes that you want to. (In Linux, you'll have to run `git push` after cloning your forked repository) +4. Make the changes that you want to (In Linux, you'll have to run `git commit -a`, and `git push` after cloning your forked repository to upload the changes). 5. Click `Pull Request` at the right-hand side of the gray bar directly below your fork's name. 6. 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. 7. Click `Send pull request`, and you're done!