You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Updates project README.md to clarify its current status, make the language around self-publication of supporting libraries more accessible, and remove the construction emoji that previously appeared.
* Update README.md
Co-authored-by: Honza Dvorsky <[email protected]>
---------
Co-authored-by: Dave Lester <[email protected]>
Co-authored-by: Konrad `ktoso` Malawski <[email protected]>
Co-authored-by: Honza Dvorsky <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+28-29Lines changed: 28 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,16 +5,32 @@ This repository contains two approaches to Swift/Java interoperability.
5
5
- Swift library (`SwiftJava`) and bindings generator that allows a Swift program to make use of Java libraries by wrapping Java classes in corresponding Swift types, allowing Swift to directly call any wrapped Java API.
6
6
- The `swift-java` tool which offers automated ways to import or "extract" bindings to sources or libraries in either language. The results are bindings for Swift or Java.
7
7
8
-
## :construction: Early Development :construction:
8
+
## Dependencies
9
+
10
+
### Required JDK versions
11
+
12
+
Note that this project consists of multiple modules which currently have different Swift and Java runtime requirements.
13
+
14
+
You'll need to install the necessary JDK version locally. On macOS for example, you can install the JDK with [homebrew](https://brew.sh) using:
15
+
16
+
```bash
17
+
$ brew install openjdk
18
+
# and create a symlink into /Library/Java/JavaVirtualMachines
**:construction: This project is in early development, please keep this in mind as you try out the project and do provide feedback about any issues you encounter. :construction:**
21
+
# or if you have a distribution as cask it will be installed into /Library/Java/JavaVirtualMachines
22
+
$ brew install --cask corretto
23
+
```
11
24
12
-
There is no guarantee about API stability of this package, neither in the Java or Swift parts, until the project releases a stable 1.0 release; APIs may change without prior notice.
25
+
Alternatively, you can use a JDK manager like [sdkman](https://sdkman.io/install/) and set your `JAVA_HOME` environment variable:
26
+
27
+
```bash
28
+
$ export JAVA_HOME="$(sdk home java current)"
29
+
```
13
30
14
-
### :construction:Self-publish support Java libraries (SwiftKit)
31
+
##Self-publish supporting Java libraries
15
32
16
-
While we work out how to provide the necessary support libraries for the Java side of Java code generated by `swift-java jextract`,
17
-
you will currently need to publish them locally and depend on them this way;
33
+
Swift-java relies on supporting libraries that are under active development and not yet published to Maven Central. To use the project, you'll need to self-publish these libraries locally so your Java project can depend on them.
18
34
19
35
To publish the libraries to your local maven repository (`$HOME/.m2`), you can run:
20
36
@@ -34,29 +50,6 @@ repositories {
34
50
35
51
We anticipate simplifying this in the future.
36
52
37
-
## Dependencies
38
-
39
-
### Required JDK versions
40
-
41
-
This project consists of different modules which have different Swift and Java runtime requirements.
42
-
43
-
On macOS for example, you can install the JDK with [homebrew](https://brew.sh) using
44
-
45
-
```bash
46
-
$ brew install openjdk
47
-
# and create a symlink into /Library/Java/JavaVirtualMachines
0 commit comments