Skip to content

Commit

Permalink
Merge pull request #4 from yerke/fix-typos
Browse files Browse the repository at this point in the history
Fix typos in README.md
  • Loading branch information
jcrist1 authored Nov 1, 2024
2 parents 16582c2 + cef5a44 commit f2e9dfe
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ this backend won't be packaged with the [diplomat tool](https://rust-diplomat.gi

# JEP 454 binding generation
In order to package this backend with the other backends there is a long term plan to implement a subset of `jextract`'s functionality.
The reasons for this include
The reasons for this include:
- reducing the amount of generated code: By default `jextract` produces wrappers for standard library code as well as other methods
that should not be unnecessary for a diplomat wrapped library.
- simplifying development setup: most diplomat developers are not not familier with java and setting up a java development environment
that should not be unnecessary for a Diplomat wrapped library.
- simplifying development setup: most Diplomat developers are not familiar with Java and setting up a Java development environment
causes unnecessary friction. Diplomat strives to enable contributors to only have to set up an environment for the language that they
need a backend for. But all diplomat contributors need to generate the code for all backends
need a backend for. But all Diplomat contributors need to generate the code for all backends.
- simplifying ci setup: `jextract` does not appear to be available via package manager, and so needs to be downloaded via URL. This is
an undesired step for diplomat's
an undesired step for Diplomat.

This [JEP 454](https://openjdk.org/jeps/454) binding generation will be developed as a library [`jextrsact`](./jextrsact/README.md) in
this repository. It will not be a replacement for jextract as it will focus only on
Expand All @@ -29,7 +29,3 @@ then pass the location of the library with `-e`, with a config path specified wi
```sh
diplomat-java -e feature/src/lib.rs -l feature/diplomat-java-conf.toml feature/tmp/
```




0 comments on commit f2e9dfe

Please sign in to comment.