Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 1.96 KB

README.md

File metadata and controls

78 lines (60 loc) · 1.96 KB

Mindolph Development

Prerequisites

  • JDK 17+
  • JavaFX 21+
  • Maven 3.x

How to setup develop environment

  • Install MFX

    git clone https://github.com/mindolph/mfx.git
    cd mfx
    mvn install -Dmaven.test.skip=true

    If there is something wrong with the accessing Maven central repository, just use the aliyun profile:
    mvn install -Dmaven.test.skip=true -Paliyun

  • Install FontawesomeFX

    git clone https://mindolph@bitbucket.org/mindolph-app/fontawesomefx.git
    cd fontawesomefx/fontawesomefx
    ./gradlew publishToMavenLocal

    for JDK 17, switch git branch:
    git switch fontawesomefx-17.0.0

  • Mindolph

    git clone https://github.com/mindolph/Mindolph.git

    Use your favourite IDE to create a new project in folder Mindolph/code, after compiling completed, launch the application by executing main method in class com.mindolph.fx.Launcher.

How to build an executable fat jar file

mvn package -Dmaven.test.skip=true

or

mvn package -Dmaven.test.skip=true -Paliyun

How to build platform dependent distribution

  • Install Packaging Tools:

    • macOS
      install Xcode command line tools
    • Debian
      install fakeroot package
    • Fedora
      install rpm-build package
    • Windows
      install third party tool WiX 3.0 or later
  • Install JavaFX jmods:

    Download latest JavaFX 21 jmods package from https://gluonhq.com/products/javafx/ and extract to somewhere like /mnt/javafx-jmods-21/

    Set environment variable:

    export JAVAFX_HOME=/mnt/javafx-jmods-21/
  • Build Mindolph distribution for your operating system:

    mvn install -Dmaven.test.skip=true

    or

    mvn install -Dmaven.test.skip=true -Paliyun

    After building is done, an executable jar file and an installer for your platform can be found in Mindolph/code/mindolph-desktop/target/