Skip to content

Commit

Permalink
Expand README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidStirling committed Jun 26, 2023
1 parent fa4468c commit 3b932af
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,32 @@ NGFF-converter is distributed under the terms of the GPL license. Please see LIC
cd NGFF-Converter-0.1-SNAPSHOT
./bin/NGFF-Converter

### Dependencies
NGFF-Converter has the following requirements/dependencies:
- Java 16+
- JavaFX
- [bioformats2raw](https://github.com/glencoesoftware/bioformats2raw)
- [raw2ometiff](https://github.com/glencoesoftware/raw2ometiff)
- [blosc](https://github.com/Blosc/c-blosc)

See `build.gradle` for more precise versioning.

### Windows & MacOS
Download prebuilt, signed binaries for these platforms [here](https://www.glencoesoftware.com/products/ngff-converter/).

### Ubuntu
You should install openjdk-17
Running from source is possible via the following steps:

sudo apt install openjdk-17-jdk

In case you get this error or similar
Install openjdk-17

Native library (linux-x86-64/libblosc.so) not found in resource path
sudo apt install openjdk-17-jdk

You should also install
Install the blosc dependency

sudo apt-get install libblosc-dev

Clone and run the repo

## Project skeleton created using a combination of:

- https://github.com/openjfx/javafx-maven-archetypes/tree/master/javafx-archetype-fxml
Expand Down

0 comments on commit 3b932af

Please sign in to comment.