Skip to content

Commit debcf7c

Browse files
committed
Update docs
1 parent 8f8e8f3 commit debcf7c

3 files changed

Lines changed: 41 additions & 12 deletions

File tree

Editor/PackageSymLinkerWindow.cs

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@ namespace CodeWriter.PackageSymLinker
1414
{
1515
public class PackageSymLinkerWindow : EditorWindow
1616
{
17-
[MenuItem("Tools/Package Symlinker/Configure...")]
17+
[MenuItem("Tools/Package Symlinker")]
1818
public static void OpenWindow()
1919
{
2020
var window = GetWindow<PackageSymLinkerWindow>();
21-
window.titleContent = new GUIContent("Package Symlinker");
2221
window.Show();
2322
}
2423

@@ -54,13 +53,6 @@ private void OnToolbarGUI()
5453

5554
GUILayout.FlexibleSpace();
5655

57-
if (GUILayout.Button("Reload", EditorStyles.toolbarButton))
58-
{
59-
Reload();
60-
}
61-
62-
GUILayout.Space(5);
63-
6456
GUILayout.EndHorizontal();
6557
}
6658

@@ -139,6 +131,8 @@ private void Reload()
139131
};
140132
})
141133
.ToList();
134+
135+
titleContent = new GUIContent($"Package Symlinker ({directories.Count})");
142136
}
143137

144138
private void AddPackage()

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,39 @@
1-
# Package Symlinker [![Github license](https://img.shields.io/github/license/codewriter-packages/Package-Symlinker.svg)](#)
1+
# Package Symlinker [![Github license](https://img.shields.io/github/license/codewriter-packages/Package-Symlinker.svg?style=flat-square)](#) [![GitHub package.json version](https://img.shields.io/github/package-json/v/codewriter-packages/Package-Symlinker?style=flat-square)](#)
22
Tool for maintaining symbolic linked packages for Unity
33

4-
NOTE: Windows only. Please check the functionality on a test project before using it in production.
4+
[![Package Symlinker Preview](https://user-images.githubusercontent.com/26966368/104042200-3a2b1b00-51eb-11eb-875c-9503cf2af12b.png)](#)
5+
6+
> NOTE: Windows only.
7+
> Please check the functionality on a test project before using it in production.
8+
9+
## About
10+
11+
Unity allow you to develop modular code and reuse it across multiple projects using packages.
12+
This packages usually placed in separate Unity project.
13+
So you development process may be similar to the following:
14+
1) Switch to project with your packages
15+
2) Edit the code
16+
3) Publish new package version to registry (github, bitbucket or your own)
17+
4) Switch to real project
18+
5) Update package to latest version
19+
6) Check that in real project all work correctly
20+
7) Repeat from step 1 if any bug found
21+
22+
It seems that it would be much more easy to edit packages directly in a real project?
23+
24+
**Package Symlinker is a tool that allows you in a couple of clicks create symbolic links to packages, so you can edit any package as if it were located right in the project.**
25+
26+
With this tool your workflow can be simplified to:
27+
1) Create a symbolic link to the package
28+
2) Edit the package directly in real project
29+
3) Delete symbolic link
30+
3) Publish new package version to registry
31+
5) Update real project to latest package version
32+
33+
## Install
34+
Library distributed as git package ([How to install package from git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html))
35+
<br>Git URL: `https://github.com/codewriter-packages/Package-Symlinker.git`
36+
37+
## License
38+
39+
Package Symlinker is [MIT licensed](./LICENSE.md).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "com.codewriter.package-symlinker",
33
"displayName": "Package Symlinker",
44
"description": "Tool for maintaining symbolic linked packages for Unity",
5-
"version": "0.1.0",
5+
"version": "1.0.0",
66
"unity": "2019.1",
77
"license": "MIT",
88
"author": "Vlad Vanifatov (https://github.com/vanifatovvlad)",

0 commit comments

Comments
 (0)