Skip to content

Commit f395cab

Browse files
authored
Update README.md
1 parent 76607a7 commit f395cab

1 file changed

Lines changed: 1 addition & 24 deletions

File tree

README.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,4 @@
1-
# Unity package template
2-
This template provides solution on how to create and maintain your package, while allowing it to be distributed through GitHub.
3-
It has CI actions, which creates/updates branch called `upm` after each commit to `main`.
4-
This is very usefull because:
5-
1. you can have whole project(with all settings) in repo so cotributing is really simple.
6-
2. users don't need to worry about extracting required folders from repo and able to just install only `upm` branch through Package Manager.
7-
8-
Look at [upm](https://github.com/STARasGAMES/Unity-package-repo-setup-template/tree/upm) branch to see how it looks.
9-
10-
Source of template: https://medium.com/openupm/how-to-maintain-upm-package-part-1-7b4daf88d4c4
11-
12-
## Steps to setup your package repo
13-
14-
* Create new repo using this project as template.
15-
* Rename folder "Packages/PACKAGE_NAME" to represent your package name and namespace (if you are using Rider). For ex: `Packages/SaG.Dependencies`.
16-
* Change PACKAGE_NAME in ".github/workflows/ci.yml" to your packages's folder name.
17-
(IMPORTANT: it's easier to use github web client to do this step, otherwise there is a big chance to mess around with git credentials)
18-
* Copy your package name, because you will need to paste it several time.
19-
1. In Unity go to your package folder and select package.json file. Change all appropriate fields.
20-
2. In Unity go to your package folder and change names for all `.asmdef` files.
21-
* Change `README.md` and `Packages/PACKAGE_NAME/README.md` installation sections accordingly to your github repo.
22-
8 Remove from `README.md` unnecessary text .
23-
241
## Installation
252
Install via git url by adding this entry in your **manifest.json**
263

27-
`"$package-name$": "https://github.com/$GitHubUsername$/$RepositoryName$.git#upm"`
4+
`"com.starasgames.unity-clean-localized-string-inspector": "https://github.com/STARasGAMES/com.starasgames.unity-clean-localized-string-inspector.git#upm"`

0 commit comments

Comments
 (0)