From 2c0520718f92cdfe3ae785f0ce89d8921f2f201a Mon Sep 17 00:00:00 2001 From: Artyom Sovetnikov Date: Sun, 21 Jul 2019 20:22:46 +0300 Subject: [PATCH] update readme --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 05e4820..a01bf7d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ -## Download unitypackage -For Unity 2017.3 and later: [SpriteGlow.unitypackage](https://github.com/Elringus/SpriteGlow/releases/download/v1.6-release/SpriteGlow.unitypackage). Check [releases](https://github.com/Elringus/SpriteGlow/releases) for previous versions support. - -Please be aware that you don't need to clone the whole repository in order to use the extension in your project. Either download package from the link above or extract `Assets/SpriteGlow` folder from the repository project – it contains all the required assets; other stuff is just for testing purposes. +## Installation +Either download and import a [standalone Unity package](https://github.com/Elringus/SpriteGlow/releases/download/v1.7-alpha/SpriteGlow.unitypackage) or add `"com.elringus.spriteglow": "https://github.com/Elringus/SpriteGlow.git#package"` as a dependency for your project's `Packages/manifest.json` ([guide](https://docs.unity3d.com/Manual/upm-git.html)). ## Description The glow effect is achieved using sprite outline in HDR colors (applied via shader) and bloom post-processing. @@ -48,4 +46,8 @@ Make sure 'Threshold' value of the bloom image effect is set high enough. It's u Most likely the outline shader is not included to the build (it happens when none of the included assets reference SpriteGlow component directly). You can force-include the shader by assigning it to the "Always Included Shaders" in Edit -> Project Settings -> Graphics. ### It's still not working -Please check the active [issues](https://github.com/Elringus/SpriteGlow/issues). +Make sure you're using a compatible Unity version; supported versions per release are available on the [releases page](https://github.com/Elringus/SpriteGlow/releases). + +Download (clone) this repository and examine the example scenes, comparing them with your setup. Chances are, you've misconfigured something. + +In case nothing of the above helps, check the active [issues](https://github.com/Elringus/SpriteGlow/issues) or open a new one. Don't forget to include the full [error log](https://docs.unity3d.com/Manual/LogFiles.html), detailed information about your system, Unity version, package version and steps required to reproduce the issue.