Add description of the project

This commit is contained in:
Jarek Sacha 2023-05-19 22:21:45 -04:00
parent 4d793fcc27
commit b4cac81a72
No known key found for this signature in database
GPG key ID: F29625CE62288163

View file

@ -1,8 +1,65 @@
IJP ImageJ Launcher
===================
IJP ImageJ Launcher is native launcher that starts [ImageJ 2] or [Fiji].
It is intended to be a general drop-in replacement for the original [ImageJ Launcher].
IJP ImageJ Launcher is a clean implementation on the core function of starting [ImageJ 2] or [Fiji].
Features
Why Another ImageJ Launcher
---------------------------
I needed to use Fji with the current versions of Java, version 11 and newer.
The original [ImageJ Launcher] works with Java 8, but not that well with the current versions,
in particular not well on Mac with Arm64 processors (Apple Silicon).
I attempted to fix the original [ImageJ Launcher source].
The source is burdened by technical debt,
the logic flow is too complex to correct without a significant rewrite.
Features [work in progress]
--------
* Launches ImageJ2 or Fiji
* Uses similar options to the original ImageJ Launcher, si IJP Launcher can be drop-in replacement
* Provides native executable for various OS/Hardware systems
- Windows
- Mac OS X Arm64 (Apple Silicon)
- Mac OS X Intel
- Linux
* Selects location of ImageJ directory
- Startup directory or
- Directory specified by `--ij-dir` command line option
* Locates Java Virtual Machine for ImageJ:
- Use Java VM requested the by the use (`--java-home`)
- Use `JAVA_HOME` environment variable
- Search ImageJ directory for available Java executables
* Determines the amount of memory used by JVM based on total system memory use 75% of the max
* Determines available `imagej-launcher*.jar`
* Performs updates pending after last time ImageJ was closed
### Full list of command line options
```
-h, --help prints this usage text
--version prints version
--dry-run show the command line, but do not run anything
--info informational output
--debug verbose output
--java-home <path> specify JAVA_HOME explicitly
--print-java-home print ImageJ's idea of JAVA_HOME
--ij-dir <path> set the ImageJ directory to <path> (used to find jars/, plugins/ and macros/)
```
Installation
------------
The IJP ImageJ Launcher executables will be available on the [Releases] page.
[//]: # (Links)
[Fiji]: https://imagej.net/software/fiji/
[ImageJ 2]: https://imagej.net/software/imagej2/
[ImageJ Launcher]:https://imagej.net/learn/launcher
[ImageJ Launcher source]:https://github.com/imagej/imagej-launcher/