Add tutorials page

LucaScheller · Nov 6, 2023 · 72a7dd5 · 72a7dd5
1 parent 160f490
commit 72a7dd5
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,13 @@ Asset resolvers that can be compiled via this repository:
 
 For more information check out the [building guide](https://lucascheller.github.io/VFX-UsdAssetResolver/installation/building.html) as well as the [individual resolvers](https://lucascheller.github.io/VFX-UsdAssetResolver/resolvers/overview.html) to see their full functionality.
 
+## Tutorials
+In this video we cover how to (build and) install the resolvers in this repository as well as how you can customize them to fit your needs.
+```admonish note title=""
+<iframe src="https://player.vimeo.com/video/881606494?h=a7ead3ad83" width="100%" height="564" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
+```
+Check out our [tutorials section](https://lucascheller.github.io/VFX-UsdAssetResolver/tutorials/overview.html) for more information.
+
 ## Contributing and Acknowledgements
 Special thanks to [Jonas Sorgenfrei](https://github.com/jonassorgenfrei) for helping bring this project to life as well as all the contributors on the Usd-Interest forum, particularly
 Mark Tucker, ColinE, Jake Richards, Pawel Olas, Joshua Miller US, Simon Boorer. 

diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -6,6 +6,7 @@
 
 
 - [Overview](./overview.md)
+    - [Video Tutorials](./tutorials/overview.md)
 - [Installation](./installation/overview.md)
     - [Automatic Installation](./installation/automatic_install.md)
     - [Requirements](./installation/requirements.md)

diff --git a/docs/src/overview.md b/docs/src/overview.md
@@ -4,7 +4,8 @@
 [![Deploy Documentation to GitHub Pages](https://github.com/LucaScheller/VFX-UsdAssetResolver/actions/workflows/mdbook.yml/badge.svg)](https://github.com/LucaScheller/VFX-UsdAssetResolver/actions/workflows/mdbook.yml)
 [![Build USD Asset Resolvers against Houdini](https://github.com/LucaScheller/VFX-UsdAssetResolver/actions/workflows/build_houdini.yml/badge.svg)](https://github.com/LucaScheller/VFX-UsdAssetResolver/actions/workflows/build_houdini.yml)
 
-This repository holds reference implementations for [Usd](https://openusd.org/release/index.html) [asset resolvers](https://openusd.org/release/glossary.html#usdglossary-assetresolution). The resolvers are compatible with the AR 2.0 standard proposed in the [Asset Resolver 2.0 Specification](https://openusd.org/release/wp_ar2.html). As the Usd documentation offers quite a good overview over the overall asset resolution system, we will not be covering it in this repository's documentation.
+This repository holds reference implementations for [Usd](https://openusd.org/release/index.html) [asset resolvers](https://openusd.org/release/glossary.html#usdglossary-assetresolution). The resolvers are compatible with the AR 2.0 standard proposed in the [Asset Resolver 2.0 Specification](https://openusd.org/release/wp_ar2.html). As the Usd documentation offers quite a good overview over the overall asset resolution system, we will not be covering it in this repository's documentation. You can find a video tutorial [here](./tutorials.md) (or on [Vimeo](https://vimeo.com/881606494)/[Youtube](https://www.youtube.com/watch?v=y4FjYprM4oA)).
+
 
 ## Installation
 To build the various resolvers, follow the instructions in the [install guide](./installation/overview.md). 
@@ -21,6 +22,4 @@ We also offer a quick install method for Houdini that does the download of the c
 Asset resolvers that can be compiled via this repository:
 {{#include ./resolvers/shared_features.md:resolverOverview}}
 
-For more information check out the [building guide](./installation/building.md) as well as the [individual resolvers](./resolvers/overview.md) to see their full functionality.
-
-
+For more information check out the [building guide](./installation/building.md) as well as the [individual resolvers](./resolvers/overview.md) to see their full functionality.
diff --git a/docs/src/tutorials/overview.md b/docs/src/tutorials/overview.md
@@ -0,0 +1,7 @@
+# Video Tutorials
+
+## Overview, installation and customization
+In this video we cover how to (build and) install the resolvers in this repository as well as how you can customize them to fit your needs.
+```admonish note title=""
+<iframe src="https://player.vimeo.com/video/881606494?h=a7ead3ad83" width="100%" height="564" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
+```