From c855f29635990a3ed2c71ab7dfb23b58045c1c43 Mon Sep 17 00:00:00 2001 From: Simon Ebner Date: Thu, 6 Mar 2014 11:02:50 +0100 Subject: [PATCH] Updated readme --- Readme.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/Readme.md b/Readme.md index 6b3aa9a..6f1d73a 100644 --- a/Readme.md +++ b/Readme.md @@ -1,3 +1,22 @@ +# Overview +ZMQ ImageJ is an ImageJ plugin for viewing images transmitted via ZMQ. It can handle data streamed via the message format defined in [ZMQ Data Steaming](https://confluence.psi.ch/display/SOF/ZMQ+Data+Streaming). + +# Installation +To install the plugin into ImageJ drop the all-in-one jar into the plugins directory of ImageJ. Afterwards (re)start ImageJ and open the plugin via _Plugins > ZeroMQ Viewer_. A plugin window will be opened where source, port and method can be specified. Once clicked on _Start_ and images are streamed from the source an additional window will open showing the images. + +# Usage +While using the ZeroMQ Viewer Plugin ImageJ need to be configured to have more memory. This can be done in the `run` file located in the ImageJ discribution. +Add/Modify following flag: `-Xmx1024m` + +# Development +To build the code run following maven command/goals: +`mvn clean compile assembly:single` + +## References +http://fiji.sc/wiki/index.php/Description_of_ImageJ's_plugin_architecture + + + # Installation Drop jar into plugins directory of the ImageJ installation.