From a6c0ee60fc9893a024e03650235d5804586b15bf Mon Sep 17 00:00:00 2001 From: Anthony Lombardi Date: Fri, 7 Jul 2023 12:59:49 -0400 Subject: [PATCH] DOC: Update README to include links to RTD and remove links to simtk --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4fa71b0b..179e97da 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,19 @@ Autoscoper has been used for tracking the shoulder, spine, wrist, hip, knee, and ## Installation -The installer for Autoscoper 2.7.1 are available [on the SimTk website](https://simtk.org/projects/autoscoper). +Autoscoper is distributed through SlicerAutoscoperM (SAM), a free, open source and multi-platform 3D Slicer extension. To learn more about the relationship between Autoscoper and AutoscoperM, see https://autoscoperm.slicer.org/. -You need to install the [CUDA toolkit](https://developer.nvidia.com/cuda-downloads?), and update your graphics card driver to run the application. +## Documentation + +Autoscoper provides documentation to help users get started and use the program effectively. The documentation is hosted on [Read the Docs](https://autoscoper.readthedocs.io). For convenience, direct links are also provided below. + +* [Getting Started][getting-started] +* [Tutorials][tutorials] + +[getting-started]: https://autoscoper.readthedocs.io/en/latest/getting-started.html +[tutorials]: https://autoscoper.readthedocs.io/en/latest/tutorials/index.html + +The documentation includes step-by-step tutorials, explanations of important concepts, and detailed information on how to use the program. ## License