diff --git a/README.md b/README.md index 77dd345ec..355ad4c7c 100644 --- a/README.md +++ b/README.md @@ -62,18 +62,19 @@ Applied Energistics 2 crashing, have a suggestion, found a bug? Create an issue ## Building 1. Clone this repository via - - SSH `git clone --recursive git@github.com:AppliedEnergistics/Applied-Energistics-2.git` or - - HTTPS `git clone --recursive https://github.com/AppliedEnergistics/Applied-Energistics-2.git` - - Note the `--recursive` option. This enables to automatically clones of all submodules. AE2 uses the [AE2-API](https://github.com/AlgorithmX2/Applied-Energistics-2-API) and [AE2-Lang](https://github.com/AppliedEnergistics/AppliedEnergistics-2-Localization) repositories. + - SSH `git clone git@github.com:AppliedEnergistics/Applied-Energistics-2.git` or + - HTTPS `git clone https://github.com/AppliedEnergistics/Applied-Energistics-2.git` 2. Setup workspace - Decompiled source `gradlew setupDecompWorkspace` - Obfuscated source `gradlew setupDevWorkspace` - CI server `gradlew setupCIWorkspace` -3. Setup IDE +3. Build `gradlew build`. Jar will be in `build/libs` +4. For core developer: Setup IDE - IntelliJ: Import into IDE and execute `gradlew genIntellijRuns` afterwards - Eclipse: execute `gradlew eclipse` -4. Build `gradlew build`. Jar will be in `build/libs` -5. (In order to have FML detect AE from your dev environment, add the following VM Option to your run profile `-Dfml.coreMods.load=appeng.transformer.AppEngCore` TODO) +5. For add-on developer: Core-Mod Detection + - In order to have FML detect AE from your dev environment, add the following VM Option to your run profile + - `-Dfml.coreMods.load=appeng.transformer.AppEngCore` ## Contribution @@ -101,6 +102,8 @@ Getting Started 5. Commit changes to your clone `git commit -m ""` 6. Push to your fork `git push` 7. Create a Pull-Request on GitHub +8. Wait for review +9. Suqash commits for cleaner history If you are only doing single file pull requests, GitHub supports using a quick way without the need of cloning your fork. Also read up about [synching](https://help.github.com/articles/syncing-a-fork) if you plan to contribute on regular basis. @@ -114,19 +117,21 @@ Development and standard builds can be obtained [Here](http://ae2.ae-mod.info/Do When compiling against the AE2 API you can use gradle dependencies, just add -dependencies { - compile "appeng:appliedenergistics2:rv_-_____-__:dev" -} + dependencies { + compile "appeng:appliedenergistics2:rv_-_____-__:dev" + } or add the compile line to your existing dependencies task to your build.gradle Where the __ are filled in with the correct version criteria; AE2 is available from the default forge maven so no additional repositories are necessary. +An example string would be `appeng:appliedenergistics2:rv2-alpha-30:dev` + ## Applied Energistics 2 Localization ### English Text -en_US is included in this repository, fixes to typos are welcome, I AlgorithmX2 will mostly likely be one of the sole contributors to this file however. +`en_US` is included in this repository, fixes to typos are welcome. ### Encoding @@ -138,11 +143,11 @@ All Text and Translations submitted here can be used for any purpose, and may be ### New Translations -You can provide any additional languages by creating a new file with the appropriate language code. +You can provide any additional languages by creating a new file with the [appropriate language code](http://download1.parallels.com/SiteBuilder/Windows/docs/3.2/en_US/sitebulder-3.2-win-sdk-localization-pack-creation-guide/30801.htm). ### Final Note -If you have have issues localizing something feel free to contact me on IRC, at #AppliedEnergistics on Esper.net +If you have have issues localizing something feel free to contact us on IRC, at #AppliedEnergistics on Esper.net Thanks to everyone helping out to improve localization of AE2. @@ -153,4 +158,4 @@ Thanks to * Notch et al for Minecraft * Lex et al for MinecraftForge * AlgorithmX2 for AppliedEnergistics2 -* all [contributors](https://github.com/AppliedEnergistics/Applied-Energistics-2/graphs/contributors) helping making this mod. +* all [contributors](https://github.com/AppliedEnergistics/Applied-Energistics-2/graphs/contributors)