Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lanthale authored Sep 30, 2023
1 parent a3aaa4f commit 551d038
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ All raw formats can be loaded with the Image class and manipulated by Pixelwrite

**JDK 18 is required for v1.8.0** because of the foreign linker API usage and the big changes for threading happenend in Panama in JDK18

**JDK 20 and JavaFX 20 is required for v1.8.4** because of the foreign linker API usage, changes in JavaFX 19 and the big changes for threading happenend in Panama in JDK19/20.
**JDK 21 and JavaFX 21 is required for v1.8.5** because of the foreign linker API usage, changes in JavaFX 21 and the big changes for threading happenend in Panama in JDK21.

## Status
Now the lib is in production ready status. That means it is tested on all operating systems (OSX, Linux, Win10) and under different threading scenarious.
Expand Down Expand Up @@ -43,12 +43,12 @@ Point to the maven coordinates:
<version>1.8.0</version>
</dependency>
```
**JDK20**
**JDK21**
```
<dependency>
<groupId>org.librawfx</groupId>
<artifactId>LibRawFX</artifactId>
<version>1.8.4</version>
<version>1.8.5</version>
</dependency>
```

Expand Down Expand Up @@ -108,15 +108,15 @@ You can also use the lib without adding the file handler. What I mean is that yo

## Steps to create your own build:
- OpenJDK/Adoptium 19 or newer
- JavaFX 11 or newer (19 is recommended)
- JavaFX 11 or newer (21 is recommended)
- SET JAVA_HOME variable
- Execute `mvn clean compile package -f LibRawFX/pom.xml`
- To run the example execute `mvn javafx:run@cli-default`
- IDE Integration: execute as a maven goal `javafx:run@ide-debug` or `javafx:run@ide-profile`

# Notes:
- The lib is using unoffical JavaFX interfaces
- The lib is using heavily the foreign memory API from Java 18 including functions from the project Panama and therefore the tool `JExtract` (Available only in JDK 19/20)
- The lib is using heavily the foreign memory API from Java 18 including functions from the project Panama and therefore the tool `JExtract` (Must be build separately)
- All classes inside of package `org.libraw.win` / `org.libraw.linuxosx` are generated by jextract but tuned for operating system specifica
- Inside of these packages above I exposed also the raw interface to libraw
- The main class to interact with the native lib is the class `LibrawImage.java` in package `org.librawfx`
Expand Down

0 comments on commit 551d038

Please sign in to comment.