Skip to content

Commit 2cc3ce4

Browse files
authored
docs: warn against cloning example repo for new mods (#320)
1 parent 33f0cf7 commit 2cc3ce4

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ We all have been there! Check out our [FAQ](https://github.com/GTNewHorizons/Exa
3030

3131
### Getting started
3232

33+
> [!WARNING]
34+
> Do not clone or fork this repository when creating a new mod. It contains files that are specific to this example project and are not part of the mod template. Use the [project starter](https://github.com/GTNewHorizons/ExampleMod1.7.10/releases/download/master-packages/starter.zip) instead.
35+
3336
Creating mod from scratch:
3437
1. Unzip [project starter](https://github.com/GTNewHorizons/ExampleMod1.7.10/releases/download/master-packages/starter.zip) into project directory.
3538
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/)

0 commit comments

Comments
 (0)