From 84a703d3fe7a169f0bf9503f116c0f677bd53c72 Mon Sep 17 00:00:00 2001 From: Krystian Ligenza Date: Thu, 3 Feb 2022 05:25:17 -0500 Subject: [PATCH 1/3] Improve documentation discoverability --- README.md | 4 +--- README_DOC.md | 10 ++++++++++ 2 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 README_DOC.md diff --git a/README.md b/README.md index df7a6311fc..9c1200837b 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,4 @@ Animal Logic forum is [here](https://groups.google.com/forum/#!forum/al_usdmaya- + [Building](doc/build.md) + [Coding guidelines](doc/codingGuidelines.md) + [License](doc/LICENSE.md) -+ [MayaToHydra](doc/MayaToHydra.md) -+ [Common Plug-in Base Commands](lib/mayaUsd/commands/Readme.md) -+ [Getting Started with USD in Maya 2022](https://help.autodesk.com/view/MAYAUL/2022/ENU/?guid=GUID-36CFE2C3-766F-4B00-8464-E94F95E7AF4B) ++ [Plugins documentation](README_DOC.md) diff --git a/README_DOC.md b/README_DOC.md new file mode 100644 index 0000000000..8bbe2a2a8b --- /dev/null +++ b/README_DOC.md @@ -0,0 +1,10 @@ +## Plugin Documentation ++ [Getting Started with USD in Maya 2022](https://help.autodesk.com/view/MAYAUL/2022/ENU/?guid=GUID-36CFE2C3-766F-4B00-8464-E94F95E7AF4B) + + +## Core Modules ++ [Common Plug-in Base Commands](lib/mayaUsd/commands/Readme.md) ++ [Managing Translation Options](lib/mayaUsd/fileio/doc/Managing_export_options_via_JobContext_in_Python.md) ++ [SchemaAPI Translators](lib/mayaUsd/fileio/doc/SchemaAPI_Import_Export_in_Python.md) ++ [MaterialX](doc/MaterialX.md) ++ [MayaToHydra](doc/MayaToHydra.md) From 3a9f3e238aeb09ac2c42aa7075af107ebcf3f7e5 Mon Sep 17 00:00:00 2001 From: Krystian Ligenza Date: Thu, 3 Feb 2022 05:38:07 -0500 Subject: [PATCH 2/3] Fixed version typo --- doc/MaterialX.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/MaterialX.md b/doc/MaterialX.md index 4b5a8d70b3..9d61de9e1e 100644 --- a/doc/MaterialX.md +++ b/doc/MaterialX.md @@ -77,7 +77,7 @@ Once the updated plugin is in use, the viewport will automatically select Materi ### Building a MaterialX-enabled USD compatible with MayaUSD -We currently use MaterialX 1.38.3 and USD 20.11. Combining these two together requires patching USD: +We currently use MaterialX 1.38.3 and USD 21.11. Combining these two together requires patching USD: ``` git checkout tags/v21.11 From ca5f7e8bef2b72e43c78390edb4a0af53bba583c Mon Sep 17 00:00:00 2001 From: Krystian Ligenza Date: Thu, 3 Feb 2022 05:47:00 -0500 Subject: [PATCH 3/3] Add more links to already existing docs --- README_DOC.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README_DOC.md b/README_DOC.md index 8bbe2a2a8b..385011d4c9 100644 --- a/README_DOC.md +++ b/README_DOC.md @@ -6,5 +6,8 @@ + [Common Plug-in Base Commands](lib/mayaUsd/commands/Readme.md) + [Managing Translation Options](lib/mayaUsd/fileio/doc/Managing_export_options_via_JobContext_in_Python.md) + [SchemaAPI Translators](lib/mayaUsd/fileio/doc/SchemaAPI_Import_Export_in_Python.md) ++ [UFE Transform](lib/mayaUsd/ufe/UsdTransform3d.md) ++ [Undo/Redo Support](lib/mayaUsd/undo/README.md) + [MaterialX](doc/MaterialX.md) ++ [MaterialX Code Gen](lib/mayaUsd/render/MaterialXGenOgsXml/README.md) + [MayaToHydra](doc/MayaToHydra.md)