Skip to content
This repository was archived by the owner on Jan 7, 2025. It is now read-only.

Commit c7aabc8

Browse files
authored
Release instructions in README.md
1 parent a216b63 commit c7aabc8

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,17 @@ We are happy to receive community contributions! For small fixes, feel free to f
196196
- `./link-speechly-sources.sh` shell script will create hard links from `speechly-dotnet/Speechly/` to `speechly-unity/Assets/com.speechly.speechly-unity/` so shared .NET code remains is in sync. Please run the script after checking out the repo and before making any changes. If you can't use the script please ensure that the files are identical manually before opening a PR.
197197
- `./build-docs.sh` generates public API documentation using DocFX from triple-slash `///` comments with C# XML documentation tags.
198198

199+
## Publishing an unitypackage
200+
201+
An unitypackage release is created with Unity's Export package feature. It should contain `com.speechly.speechly-unity` and `StreamingAssets` folders which contain Speechly-specific code and assets. Other files and folders in the project should not be included.
202+
203+
- Open `speechly-unity/speechly-unity.sln` (or any Scene file within that solution) using Unity (currently 2021.3.12f LTS)
204+
- In the Project window, select `com.speechly.speechly-unity` and `StreamingAssets` folders, then right click one of them.
205+
- In the context menu, select `Export package...`.
206+
- In the Export package window, uncheck `Include dependencies`, then click `Export...`
207+
- Name the file `speechly.unitypackage` in the root folder
208+
- Add to git and push.
209+
199210
## License, terms and privacy
200211

201212
- These Unity SDK files are distributed under MIT License.
@@ -209,4 +220,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
209220

210221
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
211222

212-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
223+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)