diff --git a/README.md b/README.md index 3edb41bfa..db83269d6 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ This mod is [licensed under the **MIT license**](https://github.com/MightyPirate 4. **Core Scripts** If you would like to contribute scripts to the "core" Lua code (which basically defines 'OpenOS'), please have a look at the [code conventions][] for Lua to save us all some time. Bug fixes are always welcome. Additional programs and features should be kept small. Bigger programs (rule of thumb: larger than 3KiB) should go onto loot disks. 5. **Drivers** - As of OC 1.4, mod interaction that was previously provided by OpenComponents it now fully integrated into OC itself. If you wish to contribute a drivers for blocks from other mods, cool! Have a look at the [integration][] package to get an idea of how to structure modules and read the readme in that package for more information (in particular on additional criteria to get your PR merged). + As of OC 1.4, mod interaction that was previously provided by OpenComponents it now fully integrated into OC itself. If you wish to contribute a driver for blocks from other mods, cool! Have a look at the [integration][] package to get an idea of how to structure modules and read the readme in that package for more information (in particular on additional criteria to get your PR merged). ####Pull requests The following are a few quick guidelines on pull requests. That is to say they are not necessarily *rules*, so there may be exceptions and all that. Just try to stick to those points as a baseline. @@ -46,14 +46,14 @@ The following are a few quick guidelines on pull requests. That is to say they a - Make sure it builds and works. - Try to keep your changes as minimal as possible. In particular, no whitespace changes in existing files, please. - Feel free to code in Java, but don't be surprised if I convert it to Scala later on, if I feel it makes the code more concise ;-) -- When adding mod dependencies, keep them *weak*, i.e. make sure OC still works without that mod. Also, prefer adding a gradle dependency over adding API class files to the repo. -- Squash your commits! +- When adding mod dependencies, keep them *weak*, i.e. make sure OC still works without that mod. Also, prefer adding a Gradle dependency over adding API class files to the repo. +- [Squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) your commits! Also, and this should go without saying, your contributed code will also fall under OC's license, unless otherwise specified (in the super rare case of adding third-party stuff, add the according license information as a `LICENSE-???` file, please). ## Extending ### In your own mod -To use [the API][api] in your own mod, either get the API JAR from the [build server][jenkins], or if you're using gradle, add a dependency to the maven repo: +To use [the API][api] in your own mod, either get the API JAR from the [build server][jenkins], or if you're using [Gradle](http://gradle.org/), add a dependency to the maven repo: ```groovy repositories { maven { url = "http://maven.cil.li/" } @@ -64,7 +64,7 @@ dependencies { ``` Adjust the version number accordingly to the version you'd like to build against. -To run the mod in your development environment, download the [`dev` JAR from the build server][dev-jar] and drop it into your dev env's `eclipse/mods` folder. +To run the mod in your development environment, download the [`dev` JAR from the build server][dev-jar] and drop it into your development environment's `eclipse/mods`(Eclipse) or `run/mods`(IntelliJ) folder. Alternatively, leave out the `api` classifier and you can build against the dev JAR directly. This way you don't have to add it to your mods folder, but you will have to add `-Dfml.coreMods.load=li.cil.oc.common.launch.TransformerLoader` to the VM options in your run configuration.