diff --git a/README.md b/README.md index 419b864..4ec653f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # coursier-jni-utils *coursier-jni-utils* is a small library allowing to tap into various Windows -native API from Java / Scala via JNI. +native APIs from Java / Scala via JNI. ## Developer docs *coursier-jni-utils* is built with -[Mill](https://com-lihaoyi.github.io/mill). It comes upwith Mill launchers +[Mill](https://com-lihaoyi.github.io/mill). It comes up with Mill launchers (`mill`, `mill.bat`), so that only a JVM and [mingw](https://www.mingw-w64.org) should be needed to build it. @@ -16,7 +16,8 @@ should be needed to build it. #### JVM A JVM, such as AdoptOpenJDK 8 or 11, is required. -`java -version` should work fine, and print a version +To check if such a JVM is installed, run +`java -version`, and check that it prints a version higher than or equal to `8`. #### mingw @@ -28,7 +29,7 @@ On Windows, the *coursier-jni-utils* build assumes mingw is installed under `C:\msys64`. If it's installed at a different location, edit the `msys2Entrypoint` method in `deps.sc` accordingly. -On Linux and macOS, the *coursier-jni-utils* build mingw gcc can be run with +On Linux and macOS, the *coursier-jni-utils* build assumes mingw gcc can be run with `x86_64-w64-mingw32-gcc`. ### IDE