Skip to content

Commit 6dc8f8f

Browse files
Dave LesterDave Lester
authored andcommitted
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.
1 parent d7e1959 commit 6dc8f8f

File tree

1 file changed

+28
-29
lines changed

1 file changed

+28
-29
lines changed

README.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,32 @@ This repository contains two approaches to Swift/Java interoperability.
55
- 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.
66
- 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.
77

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
19+
$ sudo ln -sfn /opt/homebrew/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk
920

10-
**: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+
```
1124

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+
```
1330

14-
### :construction: Self-publish support Java libraries (SwiftKit)
31+
## Self-publish supporting Java libraries
1532

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 publisehd to Maven Central. To use the project, you'll need to self-publish these libraries locally so your Java project can depend on them.
1834

1935
To publish the libraries to your local maven repository (`$HOME/.m2`), you can run:
2036

@@ -34,29 +50,6 @@ repositories {
3450

3551
We anticipate simplifying this in the future.
3652

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
48-
$ sudo ln -sfn /opt/homebrew/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk
49-
50-
# or if you have a distribution as cask it will be installed into /Library/Java/JavaVirtualMachines
51-
$ brew install --cask corretto
52-
```
53-
54-
or you can use a JDK manager like [sdkman](https://sdkman.io/install/) and set your `JAVA_HOME` environment variable
55-
56-
```bash
57-
$ export JAVA_HOME="$(sdk home java current)"
58-
```
59-
6053
## SwiftJava macros
6154

6255
SwiftJava is a Swift library offering macros which simplify writing JNI code "by hand" but also calling Java code from Swift.
@@ -231,3 +224,9 @@ xcrun docc preview Sources/SwiftJavaDocumentation/Documentation.docc
231224
# Monitoring /Users/ktoso/code/swift-java/Sources/SwiftJavaDocumentation/Documentation.docc for changes...
232225

233226
```
227+
228+
## Project Status
229+
230+
**This project is under active development. We welcome feedback about any issues you encounter.**
231+
232+
There is no guarantee about API stability until the project reaches a 1.0 release.

0 commit comments

Comments
 (0)