Browse Source

Update documentation.

Explain how to install my base POM and point to
"interesting" classes in the helper library.
master
Damien Goutte-Gattat 11 months ago
parent
commit
baba6b86d9
2 changed files with 44 additions and 7 deletions
  1. +26
    -3
      README.md
  2. +18
    -4
      src/site/apt/index.apt

+ 26
- 3
README.md View File

@ -18,16 +18,39 @@ This plugin extracts an user-specified selection of frames from a
hyperstack and generates a new image containing the selected frames
disposed in a array.
Helper Library
--------------
Bundled with the plugins is a small library of helper classes for use in
other plugins or scripts. Notable classes include `BatchReader`, to
facilitate batch processing of images listed in a CSV input file, and
`ChannelMasker`, to facilitate the creation and manipulation of
binary masks. Refer to the package´s [Javadoc]
(https://incenp.org/dvlpt/imagej-plugins/apidocs/index.html) for more
details.
Installation
------------
Build the plugins with [Maven](https://maven.apache.org/) by running
To build the plugins with [Maven](https://maven.apache.org/), first
install the parent POM from my own repository by running
```
$ mvn dependency:get -DgroupId=org.incenp -DartifactId=incenp-base \
-Dversion=1.1.0 -Dpackaging=pom \
-DremoteRepositories=https://mvn.incenp.org/repo/releases
```
You can then build the plugins by running, from the source directory
```
$ mvn package
```
in the source directory. Then copy the generated JAR file (found in the
`target/` folder) to the `plugins` folder of your ImageJ installation.
Then copy the generated JAR file (found in the `target/` folder) to the
`plugins` folder of your ImageJ installation.
(Pre-compiled JAR files are also available for each release on the
[releases page](https://git.incenp.org/damien/imagej-plugins/releases)
for the project.)
Once installed (and after restarting ImageJ if it was already running),
the plugins will be available in the `Plugins > Incenp.org` menu.


+ 18
- 4
src/site/apt/index.apt View File

@ -38,8 +38,14 @@ Java library
classes that may be used in other ImageJ plugins or scripts. Those
classes are under the <<<org.incenp.imagej>>> namespace.
Refer to {{{./apidocs/index.html}API documentation}} of the library to
know what classes are available and what you can do with them.
Refer to the {{{./apidocs/index.html}API documentation}} of the
library to know what classes are available and what you can do with
them.
Notable classes include the <<<BatchReader>>> class, to facilitate
batch processing of images listed in a CSV input file, and the
<<<ChannelMasker>>> class, to facilitate the creation and manipulation
of binary masks.
Setup
@ -73,8 +79,16 @@ $ git clone https://git.incenp.org/damien/imagej-plugins.git
The project uses {{{https://maven.apache.org/}Maven}} as its build
system, so you need to have Maven installed with the <mvn> command
available from the shell. Then, simply run the following command from
the source directory:
available from the shell. You will then need to install the parent
POM by running:
+-------------------------------------------------------------------
$ mvn dependency:get -DgroupId=org.incenp -DartifactId=incenp-base \
-Dversion=1.1.0 -Dpackaging=pom \
-DremoteRepositories=https://mvn.incenp.org/repo/releases
+-------------------------------------------------------------------
Then, simply run the following command from the source directory:
+------------
$ mvn package


Loading…
Cancel
Save