Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md to address which folder to run gen script from. #301

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Update README.md to address which folder to run gen script from. #301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00ec772
Update README.md to address which folder to run gen script from.
codabrink Sep 20, 2024
82dbf64
Merge branch 'main' into codabrink-patch-1
nplasterer Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions library/src/main/java/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Kotlin code emitted by the `bindings_ffi` crate in [libxmtp](https://github.com/
1. From repo [libxmtp](https://github.com/xmtp/libxmtp) run the [kotlin release action](https://github.com/xmtp/libxmtp/actions/workflows/release-kotlin-bindings.yml) for the branch you desire
2. Create a new branch in the `xmtp-android` repo
With `libxmtp` repo and `xmtp-android` (this repo) cloned locally in sibling directories, and `libxmtp` checked out to the correct release commit, run the script:
`./bindings_ffi/gen_kotlin.sh`
`./gen_kotlin.sh` within the `bindings_ffi` folder.
3. Run format (cmd + opt + l) function to keep the code format consistent and diff small for `xmtp-android/library/src/main/java/xmtpv3.kt`
4. Navigate to the [latest release](https://github.com/xmtp/libxmtp/releases) once the action completes
5. Download the `LibXMTPKotlinFFI.zip` assets
6. Unzip and then copy the jniLibs to `xmtp-android/library/src/main/jniLibs`
7. All instances of `value.forEach` should be changed to `value.iterator().forEach` to be compatible with API 23
8. NOTE: sometimes the library name gets updated and will cause failures the library name must be `uniffi_xmtpv3` not `xmtpv3` -- search for `findLibraryName` and make sure the correct name is returned.

You should now be on the latest libxmtp. Tests will fail if the jniLibs do not match the version of xmtpv3.
You should now be on the latest libxmtp. Tests will fail if the jniLibs do not match the version of xmtpv3.
Loading