Skip to content

Commit b3f6325

Browse files
committed
Really emphasize that you're not supposed to fork this repo
1 parent 07a7291 commit b3f6325

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,18 @@
22

33
This is an up-to-date bare-bones template for starting a multiloader Hex Casting addon on 1.20.1 with Architectury. Includes all necessary dependencies on both Forge and Fabric loaders, plus some demo bits.
44

5+
> [!CAUTION]
6+
> **Do not fork or clone this repository** to set up a new mod! See the usage steps and FAQ for more details.
7+
58
## Usage
69

710
1. Install the prerequisites:
811
- [Git](https://github.com/git-guides/install-git)
912
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
1013
- Any IDE with Java and Kotlin support (recommended: [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/?section=windows))
11-
2. Create, clone, and enter a **new** GitHub repo (**do not** fork/clone/copy this repo directly).
14+
2. Create, clone, and enter a **new** GitHub repo.
15+
> [!CAUTION]
16+
> **Do not** fork/clone/copy this repo directly.
1217
3. From the repo root, run this command to copy the template, then follow the prompts to set it up:
1318
```sh
1419
uvx copier copy gh:FallingColors/hexdummy .
@@ -60,7 +65,9 @@ The following repository contains an example of a project generated using HexDum
6065

6166
### Why isn't this a template repository / why shouldn't I fork this repo to set up my mod?
6267

63-
HexDummy uses [Copier](https://copier.readthedocs.io), a Python app for generating projects from *parameterized* templates. When you run `copier copy`, Copier clones this repository, prompts you for some values, then fills those values into many placeholders in the template, making a customized project with no placeholder values for you to have to replace by hand. As a consequence, this repository by itself is *not* a working Minecraft mod - if you look in the [template](./template) directory, you'll see a lot of `.jinja` files with placeholders that still need to be filled in.
68+
HexDummy uses [Copier](https://copier.readthedocs.io), a Python app for generating projects from *parameterized* templates. When you run `uvx copier copy`, Copier clones this repository, prompts you for some values, then fills those values into many placeholders in the template, making a customized project with no placeholder values for you to have to replace by hand.
69+
70+
As a consequence, this repository by itself is *not* a working Minecraft mod - if you look in the [template](./template) directory, you'll see a lot of `.jinja` files with placeholders that still need to be filled in.
6471

6572
### Why is the release workflow triggered manually?
6673

0 commit comments

Comments
 (0)