From b3952c568729a755df15b6089232e53f82e74efd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Tue, 21 May 2024 14:38:43 +0200 Subject: [PATCH] :memo: update readme file --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index cd01cb7..5b41b71 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,25 @@ Goal of this addon is to help distribute USD binaries: - USD AR2 plugin for __some__ supported DCCs. - USD Tools (usdcat, usdedit, usdinfo, usdview, usdzip) coming with USD build. - Standalone tools for AYON - USD interoperation. + +## Getting Started + +### Installation + +1. Clone the repository to your local machine. +2. Run `.\tools\manage.ps1 create-env` on Windows or `./tools/manage.sh create-env` on Linux. +3. Run `.\tools\manage.ps1 build` on Windows or `./tools/manage.sh build` on Linux. +4. In AYON, go to `Studio Settings` -> `Bundles` -> `Install Addons...` and select the `./package/ayon_usd-x.x.x.zip` file. +5. Upload the Addon and let the server restart after installation is done. +6. Use new addon in your bundles. + +### Configuration + +In addon settings, you can configure mapping between USD Resolver plugin and you DCCs. +`App Name` is the name of the DCC application, like `maya/2025` corresponding +to the Application addon settings. Then there is a platform settings, where you +can specify the platform for which the USD Asset Resolver plugin is used. +Lastly, there is a URL to the USD Asset Resolver plugin zip matching the platform and +the DCC application. + +`ayon+settings://ayon_usd/asset_resolvers` is the key for the settings.