toad/toad-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: tweak readme

Browse Source
This commit is contained in:
Orion Kindel 2023-04-05 10:35:55 -07:00
parent 6837291715
commit 7c96dd576b
Signed by untrusted user who does not match committer: orion
GPG Key ID: 6D4165AE4C928719
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -35,7 +35,9 @@ then run the following in bash or zsh in the directory you cloned the repo to:
> asdf plugin add coursier # skip if you have system install of coursier > asdf plugin add coursier # skip if you have system install of coursier
``` ```
##### Developing - Tooling - Manual ##### Developing - Tooling - Non-asdf
NOTE: skip this section if you are using asdf for tooling version management.
- install [openjdk](https://jdk.java.net/20/) _or equivalent_ version 20 or higher - install [openjdk](https://jdk.java.net/20/) _or equivalent_ version 20 or higher
- after installing, ensure that `$JAVA_HOME` correctly refers to JDK 20 (`java -version` should output `openjdk version "20" 202x-xx-xx`) - after installing, ensure that `$JAVA_HOME` correctly refers to JDK 20 (`java -version` should output `openjdk version "20" 202x-xx-xx`)
- install [coursier](https://get-coursier.io/docs/cli-install) - install [coursier](https://get-coursier.io/docs/cli-install)
@ -53,13 +55,11 @@ Then install `sbt`
``` ```
#### Developing - Rust #### Developing - Rust
There is a non-trivial amount of nasty glue code necessary to support the interop between There is a non-trivial amount of code necessary to support the interop between
`toad` (a rust library) and `toad-java` (a java project). `toad` (a rust library) and `toad-java` (a java project).
There is a published library [`toad-jni`](https://github.com/toad-lib/toad/tree/main/toad-jni) which contains There is a published library [`toad-jni`](https://github.com/toad-lib/toad/tree/main/toad-jni) which contains
general abstractions that are useful for this project and may be useful to others. general abstractions that are useful for this project and may be useful to others.
This includes things like _"high-level rust struct for `java.util.ArrayList`
doing nice things like implementing [`Iterator`](https://doc.rust-lang.org/nightly/core/iter/trait.Iterator.html)."_
Separately is a rust project in this repository, `./glue/`. Separately is a rust project in this repository, `./glue/`.
This is *not* a published crate and is instead source code for a This is *not* a published crate and is instead source code for a