diff --git a/README.md b/README.md new file mode 100644 index 0000000..6ed61a6 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# ExpandedBonemeal + +## Basics + +### What does this mod do? +It gives bone meal the following new abilities: +- Growing chorus flowers, cactus, sugar canes, nether wart, and vines +- Generating melons and pumpkins from their mature stems +- Duplicating lily pads and flowers as items (like sunflowers in vanilla) +- Generating dead bushes on sand, hardened clay, and stained clay +- Turning cobblestone and stone bricks into their mossy variants + +### How do I use this mod? +You need Minecraft Forge installed first. Once that's done, just drop +expandedbonemeal-*version*.jar in your Minecraft instance's mods/ directory. +Optionally, you can configure it to taste (see below). + +### What settings does this mod have? +Each new ability added by this mod can be individually disabled. + +## Development + +### How do I compile this mod from source? +You need a JDK installed first. Start a command prompt or terminal in the +directory you downloaded the source to. If you're on Windows, type +`gradlew.bat build`. Otherwise, type `./gradlew build`. Once it's done, the mod +will be saved to build/libs/expandedbonemeal-*version*.jar. + +### How can I contribute to this mod's development? +Send pull requests. Note that by doing so, you agree to release your +contributions under this mod's license. + +## Licensing/Permissions + +### What license is this released under? +It's released under the GPL v2 or later. + +### Can I use this in my modpack? +Yes, even if you monetize it with adf.ly or something, and you don't need to +ask me for my permission first.