Merge pull request #67 from Carifio24/docs-page

Add docs page and update PerTau example
glue-viz · Oct 16, 2024 · f517df1 · f517df1
2 parents 5a6f7eb + b3fc40f
commit f517df1
Show file tree

Hide file tree

Showing 34 changed files with 3,685 additions and 304 deletions.
diff --git a/README.md b/README.md
@@ -21,9 +21,12 @@ package is all handled by the package build process).
 
 ## Viewer tools
 
-The AR export tools are exposed in the toolbar as subtools of the "save" meta-tool, and can be accessed from its dropdown menu.
+In the Qt desktop application, the AR export tool is exposed in the toolbar as subtools of the "save" meta-tool, and can be accessed from its dropdown menu.
 
-![Qt viewer tool](https://raw.githubusercontent.com/Carifio24/glue-ar/master/doc/viewer_tool.gif)
+![Qt viewer tool](https://raw.githubusercontent.com/glue-viz/glue-ar/master/docs/assets/viewer_tool.gif)
+
+In glue-jupyter, the AR export tool is a top-level toolbar tool:
+![Jupyter viewer tool](https://raw.githubusercontent.com/Carifio24/glue-ar/master/docs/assets/viewer_tool_jupyter.png)
 
 ## Sharing figures