Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.1 KB

INSTALL.md

File metadata and controls

63 lines (45 loc) · 2.1 KB

Installation instructions

No stable release of the application has been made yet. Software may break and change.

From a package

Installable packages for Windows, macOS and Linux are available on a dedicated download page as well as on the Gitlab release page.

Important notes:

  • macOS and Windows packages are auto-updatable: Application will contact this website on startup for updates;
  • On Linux, installing the Debian package will add this APT repository to the system's repository list so that the application can be updated using the system's update manager;
  • Packages only contain two crossword solvers among the four available (issue #81).
  • Packages are not thoroughly tested. Feedbacks are welcome!

From sources

In order to build Croiseur GUI from sources, you need:

  • Gradle 8.5 or later
  • Java 21 or later (this one is required at run-time too)
  • Rust 2021 or later

Note that Rust is only needed for the Crossword Composer and XWords RS solvers. You may disable them by commenting the following lines in croiseur-gui's build.gradle.kts:

runtimeOnly(project(":croiseur-solver:croiseur-solver-paulgb-plugin"))
runtimeOnly(project(":croiseur-solver:croiseur-solver-szunami-plugin"))

You can build Croiseur GUI with the following command:

gradle installDist

This will generate a portable distribution of Croiseur GUI inside build/install/croiseur-gui.

You may then run the executable like this:

./croiseur-gui/build/install/croiseur-gui/bin/croiseur-gui

Alternatively, you may run the executable directly via gradle without installation with:

gradle run