feat: add cross-platform installer script and reorganize READMEs#1
Open
perNyfelt wants to merge 4 commits into
Open
feat: add cross-platform installer script and reorganize READMEs#1perNyfelt wants to merge 4 commits into
perNyfelt wants to merge 4 commits into
Conversation
- Add gui/src/main/assembly/install.sh supporting macOS, Linux and Windows (Git Bash): auto-detects OS, downloads latest release if needed, validates Java ≥21 + JavaFX, offers BellSoft Full JDK install, copies app to platform-standard directories, creates launchers/shortcuts, and asks user how to handle existing installations (remove / rename / cancel). - Update gui/createApp.sh to bundle the installer as md2pdf-install.sh at the zip root. - Move all library API documentation from root README.md into lib/README.md (now self-contained with Maven usage, styling, images, custom fonts, Spring Boot integration, third-party licenses, build/test commands). - Rewrite root README.md as a concise project overview linking to lib/README.md and gui/readme.md. - Add installation instructions to gui/readme.md referencing the new installer script.
…hange. Adds an early Swing JWindow splash before JavaFX starts, hides it after the
JavaFX window is shown, and makes the logger lazy so Log4j does not initialize before the splash.
- gui/createApp.sh: packaging tweaks that were already present. It copies md2pdf-install.sh into target/ instead of the current dir, fixes Setfile to
SetFile, and adds a final newline.
- gui/readme.md:26: removes “Amazon Corretto with JavaFX” from the recommended JavaFX JDK list.
- gui/src/main/assembly/install.sh:42: installer hardening that was already present. It changes curl auth headers to a Bash array, removes Python JSON
parsing in favor of sed, validates the actual Java binary found on PATH, checks JavaFX availability, and makes BellSoft JDK extraction detection more
robust.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
New file: `gui/src/main/assembly/install.sh`
/Applications/`, `/.local/share/MarkdownToPdf`, `~/MarkdownToPdf`)Updated files:
Why
The previous installation docs described manual per-platform steps. Now users run one script that handles everything – Java checks, download if needed, app placement, and shortcut creation."