summaryrefslogtreecommitdiff
path: root/impls/monero.rs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'impls/monero.rs/README.md')
-rw-r--r--impls/monero.rs/README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/impls/monero.rs/README.md b/impls/monero.rs/README.md
index 22a991a..e8dc15c 100644
--- a/impls/monero.rs/README.md
+++ b/impls/monero.rs/README.md
@@ -14,10 +14,17 @@ Build or download the `monero_c` library for your architecture. Follow the
upstream docs at https://github.com/MrCyjaneK/monero_c or download the latest
release from https://github.com/MrCyjaneK/monero_c/releases. The library can be
placed in one of several supported locations relative to the binary in use:
-- `../../release` (as in `monero_c/release`)
-- `./lib` (as in `monero_c/impls/monero_rust/lib`)
+- `../../../../release` (as in `monero_c/release`)
+- `../../lib` (as in `monero_c/impls/monero_rust/lib`)
- `.` (as in `monero_c/impls/monero_rust/target/debug` or `release`)
+and should match your platform as in:
+- Android: `libmonero_libwallet2_api_c.so`
+- iOS: `MoneroWallet.framework/MoneroWallet`
+- Linux: `monero_libwallet2_api_c.so`
+- macOS: `monero_libwallet2_api_c.dylib`
+- Windows: `monero_libwallet2_api_c.dll`
+
### Run demo
With the library in a supported location, from `monero_c/impls/monero_rust`:
```
@@ -25,5 +32,4 @@ cargo run
```
## Using `monero_rust` in your own crate
-Refer to the `example` folder. The `monero_c` library must be in `lib/` or in
-the same directory as the binary (*eg.* in `example/target/debug/`).
+Refer to the `example` folder. Library placement is the same as for the demo.