-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6ee9aea
commit 14c1a1a
Showing
2 changed files
with
23 additions
and
8 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) | ||
* 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)) |
This file contains 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