Skip to content

Commit f92420b

Browse files
committed
update hashing sample instructions a little bit to include details
necessary for publishing the swift-java artifacts with the least amount of annoyance
1 parent 9e10e87 commit f92420b

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

swift-java-hashing-example/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,30 @@ Before you can build and run this project, you need to have the following instal
2525

2626
## Setup and Configuration
2727

28+
### Prepare Swift Android SDK and matching Swift
29+
30+
Currently these examples utilize very recent nightly Swift Android SDK versions. In order to install these, you can use Swiftly (the Swift toolchain installer):
31+
32+
You can follow [these instructions](https://github.com/swiftlang/swift-org-website/pull/985/files) to install an appropriate Swift Android SDK.
33+
2834
### Publish `swift-java` packages locally
29-
As the `swift-java` project does not yet publish the neccessary Java packages needed at runtime, we need to do it ourself, by performing the following steps:
35+
As the `swift-java` project does not yet publish the necessary Java packages needed at runtime, we need to do it ourself, by performing the following steps:
36+
37+
> Note: This step will not be necessary once swift-java publishes releases.
38+
39+
In order to publish all artifacts from this library, we recommend installing and using JDK 25, because some parts of swift-java are built for most recent Java versions.
40+
A simple way to install and manage local Java installations is [sdkman](https://sdkman.io):
41+
42+
> Note: You will _not_ have to use most recent Java versions for your Android app, and the example currently targets Java language version 11.
43+
44+
```bash
45+
curl -s "https://get.sdkman.io" | bash
46+
sdk install java 25.0.1-amzn --use # only in order to publish swift-java artifacts locally
47+
48+
export JAVA_HOME="${HOME}//.sdkman/candidates/java/current"
49+
```
50+
51+
Next, let's prepare and publish the swift-java support libraries:
3052

3153
1. Enter the `hashing-lib` directory
3254
```bash

0 commit comments

Comments
 (0)