Skip to content

Commit 1f27f9c

Browse files
authored
Create README.md
1 parent ea42857 commit 1f27f9c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Unity-Package-Template
2+
UPM (Unity Package Manager) ready GitHub repository for Unity
3+
New Unity packages system is very easy to use and make your project much more cleaner.
4+
The repository helps you to create your own Unity package with dependecies.
5+
6+
# How to use
7+
- Fork or copy the repository
8+
- Add all your stuff to Assets/_PackageRoot directory
9+
- Update Assets/_PackageRoot/package.json to yours
10+
- (on Windows) execute gitPushToUPM.bat
11+
- (on Mac) execute gitPushToUPM.makefile
12+
- Create release from UPM branch on GitHub web page.
13+
![alt text](https://neogeek.dev/images/creating-custom-packages-for-unity-2018.3--git-release.png)
14+
15+
---
16+
17+
# How to import your package to Unity project
18+
You may use one of the variants
19+
20+
## Variant 1
21+
- Select "Add package from git URL"
22+
- Paste URL to your GitHub repository with simple modification:
23+
-- <code>https://github.com/USER/REPO.git#upm</code> Dont forget to replace **USER** and **REPO** to yours
24+
![alt text](https://neogeek.dev/images/creating-custom-packages-for-unity-2018.3--package-manager.png)
25+
26+
## Variant 2
27+
Modify manifest.json file.
28+
Chacnge "your.own.package" to the name of your package.
29+
Dont forget to replace **USER** and **REPO** to yours.
30+
<pre><code>{
31+
"dependencies": {
32+
"your.own.package": "https://github.com/USER/REPO.git#upm"
33+
}
34+
}
35+
</code></pre>

0 commit comments

Comments
 (0)