Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Update README to include links to RTD and remove links to simtk #145

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down