Skip to content

Commit 48a230c

Browse files
FlatBuffers update: add docs for update script.
1 parent 499b52f commit 48a230c

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

objectbox-java/src/main/java/io/objectbox/flatbuffers/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ to avoid conflicts with FlatBuffers generated Java code from users of this libra
66
Current version: see `Constants.java`.
77

88
Copy a different version using the script in `scripts\update-flatbuffers.sh`.
9+
It expects FlatBuffers source files in the `../flatbuffers` directory (e.g. check out
10+
the desired FlatBuffers tag from https://github.com/google/flatbuffers next to this repo).
11+
The Java library is expected in `objectbox-java`, e.g. run the script from the root of this repo.
912

1013
## Licensing
1114

scripts/update-flatbuffers.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
#!/usr/bin/env bash
22
set -euo pipefail
33

4+
# Expects FlatBuffers source files in the `../flatbuffers` directory,
5+
# the Java library in `objectbox-java`, e.g. run this from the root of this repo.
6+
47
script_dir=$(dirname "$(readlink -f "$0")")
58
cd "${script_dir}/.." # move to project root dir or exit on failure
69
echo "Running in directory: $(pwd)"

0 commit comments

Comments
 (0)