From 57ed697cab9391aeb09370a5c394c15a1cfddd46 Mon Sep 17 00:00:00 2001 From: cpw Date: Tue, 12 Jul 2016 21:24:13 -0400 Subject: [PATCH] Lets make a half-decent readme. Thanks to Rorax for the install video! --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..bf68f74911 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# How to install Forge: For Players + +Go to [http://files.minecraftforge.net](http://files.minecraftforge.net) + and select the minecraft version you wish to get forge for from the list. + +You can download the installer for the *Recommended Build* or the + *Lastest build* there. Latest builds may have newer features but may be + more unstable as a result. The installer will attempt to install forge + into your vanilla launcher environment, where you can then create a new + profile using that version and play the game! + +Here is a short video from Rorax showing how to install and setup Forge. + +[![HOWTO Install Forge](https://img.youtube.com/vi/lB3ArN_-3Oc/0.jpg)](https://www.youtube.com/watch?v=lB3ArN_-3Oc) + +For support and user questions, visit [http://www.minecraftforge.net](http://www.minecraftforge.net). + +# How to install Forge: For Modders + +If you wish to setup a new mod for Forge, visit + [http://files.minecraftforge.net](http://files.minecraftforge.net) and + select the **MDK** download. + +This is the `Modder Developer Kit` - basically, an example mod with all + the tooling needed to create a Forge mod workspace ready for use in your + IDE of choice. + +Here is a short video from @cpw showing how to install and setup the MDK + in Intellij. + +[![HOWTO Install MDK](https://img.youtube.com/vi/PfmlNiHonV0/0.jpg)](https://www.youtube.com/watch?v=PfmlNiHonV0) + +# How to install Forge: For those wishing to work on Forge itself + +If you wish to actually inspect Forge, submit PRs or otherwise work + with Forge itself, you're in the right place! Clone this (either + directly, or make a Fork first if you want to make a PR) and run + ```gradlew.bat setup``` or ```gradlew setup```. This will download and + setup all the bits you need to have a functional Forge workspace. + +Here is a short video from @cpw showing how to install and setup Forge + in Intellij. + +[![HOWTO Install MDK](https://img.youtube.com/vi/yanCpy8p2ZE/0.jpg)](https://www.youtube.com/watch?v=yanCpy8p2ZE) + +## Pull requests + +Pull requests should target the current default branch. Currently, that is + the 1.10.x branch for Minecraft 1.10.2. + +If you intend to modify a minecraft patch, or add a new one, always run +```gradlew genPatches``` to generate your patch and validate that you +are not doing anything unexpected in your patch. + +### Contributor License Agreement +As stated in the (https://github.com/MinecraftForge/MinecraftForge/blob/1.10.x/LICENSE-new.txt) + file, we require all contributors to acknowledge the Forge Contributor + License Agreement. Please ensure you have a valid email address + associated with your github account to do this. If you have previously + signed it, you should be OK. \ No newline at end of file