Commit 37ef16f3 authored by Andrey Filippov's avatar Andrey Filippov

customized readme

parent 4665aba0
This is a minimal Maven project implementing an ImageJ 1.x plugin
It is intended as an ideal starting point to develop new ImageJ 1.x plugins
in an IDE of your choice. You can even collaborate with developers using a
different IDE than you.
In [Eclipse](, for example, it is as simple as
_File>Import...>Existing Maven Project_
In [Netbeans](, it is even simpler: _File>Open_
Project. The same works in [IntelliJ](
If [jEdit]( is your preferred IDE, you will need the [Maven
Die-hard command-line developers can use Maven directly by calling _mvn_
in the project root.
However you build the project, in the end you will have the ```.jar``` file
(called *artifact* in Maven speak) in the _target/_ subdirectory.
To copy the artifact into the correct place, you can call ```mvn```. This will not only copy your
artifact, but also all the dependencies. Restart your ImageJ or call
*Help>Refresh Menus* to see your plugin in the menus.
Developing plugins in an IDE is convenient, especially for debugging. To
that end, the plugin contains a _main()_ method which sets the _plugins.dir_
system property (so that the plugin is added to the Plugins menu), starts
ImageJ, loads an image and runs the plugin. See also
[this page](
for information how Fiji makes it easier to debug in IDEs.
Since this project is intended as a starting point for your own
developments, it is in the public domain.
How to use this project as a starting point
* ```git clone git://```, or
* unpack
1. Edit the ```pom.xml``` file. Every entry should be pretty self-explanatory.
In particular, change
1. the *artifactId* (and optionally also *groupId*)
2. the *version* (note that you typically want to use a version number
ending in *-SNAPSHOT* to mark it as a work in progress rather than a
final version)
3. the *dependencies* (read how to specify the correct
*groupId/artifactId/version* triplet
4. the *developer* information
5. the *scm* information
2. Remove the `````` file and add your own ```.java``` files
to ```src/main/java/<package>/``` (if you need supporting files -- like icons
-- in the resulting ```.jar``` file, put them into ```src/main/resources/```)
3. Edit ```src/main/resources/plugins.config```
4. Replace the contents of `````` with information about your project.
If you cloned the ```minimal-ij1-plugin``` repository, you probably want to
publish the result in your own repository:
1. Call ```git status``` to verify .gitignore lists all the files (or file
patterns) that should be ignored
2. Call ```git add .``` and ```git add -u``` to stage the current files for
3. Call ```git commit``` or ```git gui``` to commit the changes
4. [Create a new GitHub repository](
5. ```git remote set-url origin<username>/<projectname>```
6. ```git push origin HEAD```
This is a set of Elphel plugins for ImageJ 1.x as a Maven project with specified
If cloned and imported as existent Maven project into Eclipse IDE, it allows to launch
ImageJ with plugins in both run and debug modes.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment