Skip to content

Commit 8f64ef4

Browse files
committed
README: update various things
* Link destinations aligned with the revamped ImageJ wiki. * Terminology: ImageJ2, not the original ImageJ. * Update pom-scijava-base reference from 3.0.0 to 14.0.0. * Recommend to use a specific tag on forum.image.sc.
1 parent 6155484 commit 8f64ef4

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
The pom-scijava-base project is a Maven POM that serves as the base for all
55
Maven-based SciJava software, including:
66

7-
| Fiji | ImageJ | ImgLib2 | KNIME | LOCI | SCIFIO | SciJava | FLIMLib | Virtual Cell |
8-
|:----:|:------:|:-------:|:-----:|:----:|:------:|:-------:|:----------:|:------------:|
9-
| [![Fiji](https://scijava.org/icons/fiji-icon-64.png)](https://github.com/fiji) | [![ImageJ](https://scijava.org/icons/imagej2-icon-64.png)](https://github.com/imagej) | [![ImgLib2](https://scijava.org/icons/imglib2-icon-64.png)](https://github.com/imglib) | [![KNIME](https://scijava.org/icons/knime-icon-64.png)](https://knime.org) | [![LOCI](https://scijava.org/icons/loci-icon-64.png)](https://github.com/uw-loci) | [![SCIFIO](https://scijava.org/icons/scifio-icon-64.png)](https://github.com/scifio) | [![SciJava](https://scijava.org/icons/scijava-icon-64.png)](https://github.com/scijava) | [![FLIMLib](https://scijava.org/icons/flimlib-icon-64.png)](https://github.com/flimlib) | [![Virtual Cell](https://scijava.org/icons/vcell-icon-64.png)](https://github.com/virtualcell) |
7+
| Fiji | ImageJ2 | ImgLib2 | KNIME | LOCI | SCIFIO | SciJava | FLIMLib | Virtual Cell |
8+
|:----:|:-------:|:-------:|:-----:|:----:|:------:|:-------:|:----------:|:------------:|
9+
| [![Fiji](https://scijava.org/icons/fiji-icon-64.png)](https://github.com/fiji) | [![ImageJ2](https://scijava.org/icons/imagej2-icon-64.png)](https://github.com/imagej) | [![ImgLib2](https://scijava.org/icons/imglib2-icon-64.png)](https://github.com/imglib) | [![KNIME](https://scijava.org/icons/knime-icon-64.png)](https://knime.org) | [![LOCI](https://scijava.org/icons/loci-icon-64.png)](https://github.com/uw-loci) | [![SCIFIO](https://scijava.org/icons/scifio-icon-64.png)](https://github.com/scifio) | [![SciJava](https://scijava.org/icons/scijava-icon-64.png)](https://github.com/scijava) | [![FLIMLib](https://scijava.org/icons/flimlib-icon-64.png)](https://github.com/flimlib) | [![Virtual Cell](https://scijava.org/icons/vcell-icon-64.png)](https://github.com/virtualcell) |
1010

1111
## pom-scijava-base vs. pom-scijava
1212

@@ -19,9 +19,9 @@ use [pom-scijava](https://github.com/scijava/pom-scijava) as parent.
1919

2020
See these examples for guidance:
2121

22-
* [ImageJ command template](https://github.com/imagej/example-imagej-command)
22+
* [ImageJ2 command template](https://github.com/imagej/example-imagej-command)
2323
* [ImageJ 1.x plugin template](https://github.com/imagej/example-legacy-plugin)
24-
* [ImageJ tutorials](https://github.com/imagej/tutorials)
24+
* [ImageJ2 tutorials](https://github.com/imagej/tutorials)
2525

2626
## Enforcer rules declared in this parent
2727

@@ -67,7 +67,7 @@ we believe make SciJava-based projects more reproducible and more consistent:
6767
are best used for testing only; they can be used transiently, but their use
6868
should never make it onto the main integration branch
6969
(e.g., `main` or `master`) of a project. See also
70-
[Using snapshot couplings during development](https://imagej.net/Architecture#Using_snapshot_couplings_during_development).
70+
[Using snapshot couplings during development](https://imagej.net/develop/architecture#using-snapshot-couplings-during-development).
7171

7272
* __Developer roles.__ SciJava-based projects define developers and
7373
contributors with roles matching the
@@ -76,10 +76,13 @@ we believe make SciJava-based projects more reproducible and more consistent:
7676
careful about which developers are pledging which sorts of responsibility,
7777
the social status of each project becomes much clearer, and which social
7878
actions to take in various circumstances becomes a more tractable problem.
79-
We have [automated tooling](https://github.com/scijava/mediawiki-maven-info)
80-
which generates MediaWiki sidebar templates for all components of the
81-
[ImageJ software stack](https://imagej.net/Architecture#Definitions); this
82-
tooling requires SciJava developer roles to be present for sensible results.
79+
We have
80+
[automated tooling](https://github.com/imagej/imagej.github.io/blob/main/assets/js/maven.js)
81+
which can populates a statbox sidebar for any component built on SciJava,
82+
including all components of the
83+
[ImageJ2 software stack](https://imagej.net/develop/architecture#definitions);
84+
this tooling requires SciJava developer roles to be present for sensible
85+
results.
8386

8487
* __Required metadata.__ Every SciJava-based project must override key pieces
8588
of metadata, including the `name`, `description`, `url`, `inceptionYear`,
@@ -135,8 +138,8 @@ we believe make SciJava-based projects more reproducible and more consistent:
135138
to clearly communicate the project license, to clearly document community
136139
expectations, to give credit where credit is due, etc.
137140

138-
The full set of Enforcer rules as of `pom-scijava-base` version 3.0.0 can be
139-
[seen here](https://github.com/scijava/pom-scijava-base/blob/pom-scijava-base-3.0.0/pom.xml#L542-L638).
141+
The full set of Enforcer rules as of `pom-scijava-base` version 14.0.0 can be
142+
[seen here](https://github.com/scijava/pom-scijava-base/blob/pom-scijava-base-14.0.0/pom.xml#L831-L926).
140143

141144
### How to override a field with an "empty" value
142145

@@ -170,10 +173,12 @@ how best to override those values accordingly. The most common scenarios are:
170173
<mailingLists>
171174
<mailingList>
172175
<name>Image.sc Forum</name>
173-
<archive>https://forum.image.sc/</archive>
176+
<archive>https://forum.image.sc/tag/your-tag</archive>
174177
</mailingList>
175178
</mailingLists>
176179
```
180+
Where `your-tag` is the tag you want to
181+
be used when discussing your project.
177182
* If your project has no CI, write:
178183
```xml
179184
<ciManagement>
@@ -194,11 +199,11 @@ how best to override those values accordingly. The most common scenarios are:
194199
</scm>
195200
```
196201
But as an aside, in this case, we strongly encourage you to adopt an SCM;
197-
[check yourself before you wreck yourself](https://imagej.net/Distribution).
202+
[check yourself before you wreck yourself](https://imagej.net/contribute/distributing).
198203

199204
## Getting help with Maven
200205

201206
For more information about Maven, see:
202207

203-
* [ImageJ Maven overview](https://imagej.net/Maven)
204-
* [ImageJ Maven FAQ](https://imagej.net/Maven_-_Frequently_Asked_Questions)
208+
* [ImageJ Maven overview](https://imagej.net/develop/maven)
209+
* [ImageJ Maven FAQ](https://imagej.net/develop/maven-faq)

0 commit comments

Comments
 (0)