Skip to content

Commit a966d8b

Browse files
committed
README tweaks
- Mention cbindgen - Mention acknowledgments' README - Un-mention submodules (the one we had was removed)
1 parent 07db59f commit a966d8b

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,6 @@ On a Debian-like system, you can get these extra dependencies through `apt`:
4949
$ apt-get install clang libclang-dev cmake make protobuf-compiler git
5050
```
5151

52-
Additionally, some of the tests in this repository rely on submodules being checked out:
53-
54-
```shell
55-
$ git submodule update --init
56-
```
57-
5852
The build currently uses a specific version of the Rust nightly compiler, which
5953
will be downloaded automatically by cargo. To build and test the basic protocol
6054
libraries:
@@ -66,6 +60,9 @@ $ cargo test
6660
...
6761
```
6862

63+
When making a PR that adjusts dependencies, you'll need to regenerate our acknowledgments files.
64+
See [``acknowledgments/README.md``](acknowledgments/).
65+
6966
## Java/Android
7067

7168
To build for Android you must install several additional packages including a JDK,
@@ -92,7 +89,11 @@ $ make
9289
```
9390

9491
When exposing new APIs to Java, you will need to run `rust/bridge/jni/bin/gen_java_decl.py` in
95-
addition to rebuilding.
92+
addition to rebuilding. This requires installing the `cbindgen` Rust tool:
93+
94+
```shell
95+
$ cargo +stable install cbindgen
96+
```
9697

9798
### Maven Central
9899

swift/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,11 @@ When exposing new APIs to Swift, you will need to add the `--generate-ffi` flag
4242
2. Use `swift build` and `swift test` as usual from within the `swift/` directory.
4343

4444
When exposing new APIs to Swift, you will need to add the `--generate-ffi` flag to your
45-
`build_ffi.sh` invocation.
45+
`build_ffi.sh` invocation. This requires installing the `cbindgen` Rust tool:
4646

47+
```shell
48+
$ cargo +stable install cbindgen
49+
```
4750

4851
## Use as a Swift Package
4952

0 commit comments

Comments
 (0)