diff --git a/README.md b/README.md index 7c8c248..4c89bef 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,31 @@ # QuPath FX ## What's here? +This repository contains code that can help when working with JavaFX. -This repository contains several Java modules that can help when working with JavaFX. +It's developed alongside [QuPath](https://qupath.github.io), but intended to be reusable across other projects too. -The code is developed alongside [QuPath](https://qupath.github.io), but is intended to be useful for other projects too. +In this way, it's similar in purpose to [ControlsFX](https://controlsfx.github.io) and [JFxtras](https://jfxtras.org) (which gave some inspiration for the name), but distinct from both. -## Dependencies +## Features +The main features are: + +* **Controls** - several custom controls, including a rotation slider and input display window (to show mouse and keyboard input) +* **Dialogs** - to simplify showing custom dialogs - and notifications, if ControlsFX is available +* **Localization** - to help manage `StringProperty` instances backed by resource bundles +* **Prefs** - to support creating JavaFX properties backed by Java `Preferences` +* **Utils** - Other helper classes, to reduce some boilerplate -Note that *these modules don't require other QuPath modules*. -The dependencies are: + +## Dependencies +Dependencies are minimal to try to keep things simple. They are: * JavaFX * SLF4J-API -* ControlsFX (optional) \ No newline at end of file +* ControlsFX *(optional)* + + +## License +This project is licensed under Apache 2.0. + +(Note that this is a [different open-source license from QuPath's](https://github.com/qupath/qupath)) \ No newline at end of file diff --git a/build.gradle b/build.gradle index f886b7c..ffc1f94 100644 --- a/build.gradle +++ b/build.gradle @@ -4,10 +4,10 @@ plugins { id 'org.openjfx.javafxplugin' version '0.0.14' } -ext.moduleName = 'qupath.fx' +ext.moduleName = 'qupath.fxtras' ext.jdkVersion = 17 -archivesBaseName = 'qupath-fx' +archivesBaseName = 'qupath-fxtras' description = "Extra classes built on JavaFX that are used to help create the QuPath user interface. " + "These don't depend on other QuPath modules, so can be reused elsewhere."