Skip to content

Commit

Permalink
Update README to prepare for switch to Fiji updater
Browse files Browse the repository at this point in the history
  • Loading branch information
jefferis committed Apr 20, 2015
1 parent b122829 commit b5371a8
Showing 1 changed file with 29 additions and 14 deletions.
43 changes: 29 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ Install
=======

* Install [Fiji](http://fiji.sc/)
* Enable the **CMTK Registration** update site (http://sites.imagej.net/Jefferis),
by following [these detailed instructions](http://imagej.net/How_to_follow_a_3rd_party_update_site).
* Run `Plugins>CMTK Registration>Install CMTK` to install CMTK

Use
===

* **CMTK Registration GUI** is the main entry point
* See [Jefferis Lab Wiki](http://flybrain.mrc-lmb.cam.ac.uk/dokuwiki/doku.php?id=warping_manual:registration_gui)

Update
======

* Use the Fiji updater to update files (but see below for Developer Install/Update)
* To update the CMTK registration software, choose `Install CMTK`
* This will compare the current version on the CMTK website with the installed version and offer to update if appropriate.

Problems
========

* If you have trouble please check the list of [previously reported bugs](https://github.com/jefferis/fiji-cmtk-gui/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Abug). There may already be a solution.
* See also the [NITRC CMTK User Forum](https://www.nitrc.org/forum/forum.php?forum_id=857)

Developer Install
=================

* Download the [zip file](https://github.com/jefferis/fiji-cmtk-gui/zipball/master) for this repository
* Expand the zip file
* Rename the newly expanded folder to `CMTK_Registration`
Expand All @@ -17,18 +43,7 @@ Install
* (Re)start Fiji
* Choose **Plugins ... CMTK Registration ... Install CMTK**

Update
======
* To update the code for this GUI, choose `Update CMTK GUI`
* To update the CMTK registration software, choose `Install CMTK`
* This will compare the current version on the CMTK website with the installed version and offer to update if appropriate.

Use
===
* **CMTK Registration GUI** is the main entry point
* See [Jefferis Lab Wiki](http://flybrain.mrc-lmb.cam.ac.uk/dokuwiki/doku.php?id=warping_manual:registration_gui)
Developer Update
================

Problems
========
* If you have trouble please check the list of [previously reported bugs](https://github.com/jefferis/fiji-cmtk-gui/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Abug). There may already be a solution.
* See also the [NITRC CMTK User Forum](https://www.nitrc.org/forum/forum.php?forum_id=857)
* To update the code for this GUI, choose `Update to Developer CMTK GUI`

0 comments on commit b5371a8

Please sign in to comment.