Skip to content

Commit

Permalink
Add documentation link to README (#67)
Browse files Browse the repository at this point in the history
Add link to documentation at https://jni.github.io/affinder/

The gh-pages docs don't pop up for me in a google search for affinder,
whereas the github repo is easy to find.

This makes it too easy to assume that there are no docs, which is a
shame given all the hard work James put into PR
#53
  • Loading branch information
GenevieveBuckley authored Oct 3, 2023
1 parent af68ac6 commit 960fcc7
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,16 @@

Quickly find the affine matrix mapping one image to another using manual correspondence points annotation

----------------------------------

This [napari] plugin was generated with [Cookiecutter] using with [@napari]'s [cookiecutter-napari-plugin] template.

<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started
and review the napari docs for plugin developers:
https://napari.org/docs/plugins/index.html
-->

## Installation

You can install `affinder` via [pip]:

pip install affinder

## Documentation

The affinder documentation is available here: [https://jni.github.io/affinder/](https://jni.github.io/affinder/)

## Contributing

Contributions are very welcome. Tests can be run with [tox], please ensure
Expand Down Expand Up @@ -55,3 +47,15 @@ If you encounter any problems, please [file an issue] along with a detailed desc
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/

----------------------------------

This [napari] plugin was generated with [Cookiecutter] using with [@napari]'s [cookiecutter-napari-plugin] template.

<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started
and review the napari docs for plugin developers:
https://napari.org/docs/plugins/index.html
-->

0 comments on commit 960fcc7

Please sign in to comment.