From b4cac81a7238d562a3b30e367a00631186e0830a Mon Sep 17 00:00:00 2001 From: Jarek Sacha Date: Fri, 19 May 2023 22:21:45 -0400 Subject: [PATCH] Add description of the project --- ReadMe.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 59 insertions(+), 2 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index 123ee94..1338d3d 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -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 \ No newline at end of file +* 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 specify JAVA_HOME explicitly + --print-java-home print ImageJ's idea of JAVA_HOME + --ij-dir set the ImageJ directory to (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/ \ No newline at end of file