Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexarchambault authored Sep 7, 2021
1 parent 33ef1d3 commit 74ea222
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 74ea222

Please sign in to comment.