Skip to content

Commit 84247f0

Browse files
committed
Update README.md
1 parent 08b96bc commit 84247f0

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,19 @@
11
# Unity package template
2+
3+
This is a template repository for creating new repositories for upm (Unity Package Manager) packages.
4+
5+
## Usage
6+
7+
1. Create a new repository using this template
8+
2. Clone the new repository
9+
3. Run RUNME.sh (cautiously!) with bash at new repository root folder and follow instructions, if using windows [Git for Windows](https://gitforwindows.org/) provides bash and all necessary tools.
10+
4. Move all files (expect folders .git/ .github/ and Samples/) inside any Unity Project Assets folder. This will generate .meta files that are required by Unity.
11+
5. Move files back to the original folder
12+
13+
**Notes:**
14+
- RUNME.sh just helps replacing all tags etc. `{{REPOSITORY_NAME}}` or `{{DESCRIPTION}}` from files, if not familiar with bash scripts this step should be done manually
15+
- Brief introduction on how to develop your Unity package is included in CONTRIBUTING.md
16+
17+
For further details, please see
18+
- [Github docs on creating repository from template](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
19+
- [Unity docs on creating custom packages.](https://docs.unity3d.com/Manual/CustomPackages.html)

0 commit comments

Comments
 (0)