From 72a7dd5d8041455f59c035c8418e6c5935c634a1 Mon Sep 17 00:00:00 2001 From: Luca Scheller Date: Mon, 6 Nov 2023 11:08:57 +0100 Subject: [PATCH] Add tutorials page --- README.md | 7 +++++++ docs/src/SUMMARY.md | 1 + docs/src/overview.md | 7 +++---- docs/src/tutorials/overview.md | 7 +++++++ 4 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 docs/src/tutorials/overview.md diff --git a/README.md b/README.md index 0076d9e..cd40f85 100644 --- 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="" + +``` +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 index 04a79e3..a0925fe 100644 --- 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 index 218a2ea..fad8922 100644 --- 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. \ No newline at end of file diff --git a/docs/src/tutorials/overview.md b/docs/src/tutorials/overview.md new file mode 100644 index 0000000..81b1069 --- /dev/null +++ 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="" + +```