From 43b34e5b64f2aeda9547c06753fce5d4ad90970f Mon Sep 17 00:00:00 2001 From: Dmytro <13066272+TheElan@users.noreply.github.com> Date: Sat, 13 Nov 2021 21:29:37 +0200 Subject: [PATCH] readme: add license step to getting started --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d837abc..30bd841 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,12 @@ We had our fair share in struggles with build scripts for Minecraft Forge. There Creating mod from scratch: 1. Unzip [project starter](https://github.com/SinTh0r4s/ExampleMod1.7.10/releases/download/latest-starer/starter.zip) into project directory. -2. Ensure your project is under VCS. For example initialise git repository by running `git init; git commit --message "initialized repository"`. -3. Replace placeholders (edit values in gradle.properties, change example package and class names, etc.) -4. Run `./gradlew setupDecompWorkspace` (if build fails with `Could not find :forgeBin:1.7.10-10.13.4.1614-1.7.10.` this should fix it) -5. Make sure to check out the rest sections of this file. -6. You are good to go! +2. Replace placeholders in LICENSE-template and rename it to LICENSE, or remove LICENSE-template and put any other license you like on your code. This is an permissive OSS project and we encourage you participate in OSS movement by having permissive license like one in template. You can find out pros and cons of OSS software in [this article](https://www.freecodecamp.org/news/what-is-great-about-developing-open-source-and-what-is-not/) +3. Ensure your project is under VCS. For example initialise git repository by running `git init; git commit --message "initialized repository"`. +4. Replace placeholders (edit values in gradle.properties, change example package and class names, etc.) +5. Run `./gradlew setupDecompWorkspace` (if build fails with `Could not find :forgeBin:1.7.10-10.13.4.1614-1.7.10.` this should fix it) +6. Make sure to check out the rest sections of this file. +7. You are good to go! We also have described guidelines for existing mod [migration](docs/migration.md) and [porting](docs/porting.md)