Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vanifatovvlad committed Jan 8, 2021
1 parent 8f8e8f3 commit debcf7c
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 12 deletions.
12 changes: 3 additions & 9 deletions Editor/PackageSymLinkerWindow.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ namespace CodeWriter.PackageSymLinker
{
public class PackageSymLinkerWindow : EditorWindow
{
[MenuItem("Tools/Package Symlinker/Configure...")]
[MenuItem("Tools/Package Symlinker")]
public static void OpenWindow()
{
var window = GetWindow<PackageSymLinkerWindow>();
window.titleContent = new GUIContent("Package Symlinker");
window.Show();
}

Expand Down Expand Up @@ -54,13 +53,6 @@ private void OnToolbarGUI()

GUILayout.FlexibleSpace();

if (GUILayout.Button("Reload", EditorStyles.toolbarButton))
{
Reload();
}

GUILayout.Space(5);

GUILayout.EndHorizontal();
}

Expand Down Expand Up @@ -139,6 +131,8 @@ private void Reload()
};
})
.ToList();

titleContent = new GUIContent($"Package Symlinker ({directories.Count})");
}

private void AddPackage()
Expand Down
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,39 @@
# Package Symlinker [![Github license](https://img.shields.io/github/license/codewriter-packages/Package-Symlinker.svg)](#)
# 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)](#)
Tool for maintaining symbolic linked packages for Unity

NOTE: Windows only. Please check the functionality on a test project before using it in production.
[![Package Symlinker Preview](https://user-images.githubusercontent.com/26966368/104042200-3a2b1b00-51eb-11eb-875c-9503cf2af12b.png)](#)

> NOTE: Windows only.
> Please check the functionality on a test project before using it in production.
## About

Unity allow you to develop modular code and reuse it across multiple projects using packages.
This packages usually placed in separate Unity project.
So you development process may be similar to the following:
1) Switch to project with your packages
2) Edit the code
3) Publish new package version to registry (github, bitbucket or your own)
4) Switch to real project
5) Update package to latest version
6) Check that in real project all work correctly
7) Repeat from step 1 if any bug found

It seems that it would be much more easy to edit packages directly in a real project?

**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.**

With this tool your workflow can be simplified to:
1) Create a symbolic link to the package
2) Edit the package directly in real project
3) Delete symbolic link
3) Publish new package version to registry
5) Update real project to latest package version

## Install
Library distributed as git package ([How to install package from git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html))
<br>Git URL: `https://github.com/codewriter-packages/Package-Symlinker.git`

## License

Package Symlinker is [MIT licensed](./LICENSE.md).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "com.codewriter.package-symlinker",
"displayName": "Package Symlinker",
"description": "Tool for maintaining symbolic linked packages for Unity",
"version": "0.1.0",
"version": "1.0.0",
"unity": "2019.1",
"license": "MIT",
"author": "Vlad Vanifatov (https://github.com/vanifatovvlad)",
Expand Down

0 comments on commit debcf7c

Please sign in to comment.