summaryrefslogtreecommitdiff
path: root/impls/monero_rust/README.md
diff options
context:
space:
mode:
authorsneurlax <sneurlax@gmail.com>2024-10-10 21:26:30 -0500
committersneurlax <sneurlax@gmail.com>2024-10-10 21:26:30 -0500
commitc2c2f2c00dba3b7253627ddfaec37b2d015ba36b (patch)
tree9ec455da551e730e87ac573b929cf6f9244bb82d /impls/monero_rust/README.md
parent4694bb913f7709c2b2fa568f065cc56f92f09555 (diff)
allow lib to be loaded by consumer crates
and document the required placement
Diffstat (limited to 'impls/monero_rust/README.md')
-rw-r--r--impls/monero_rust/README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/impls/monero_rust/README.md b/impls/monero_rust/README.md
index 5affbd1..87d23a3 100644
--- a/impls/monero_rust/README.md
+++ b/impls/monero_rust/README.md
@@ -10,7 +10,7 @@ sudo apt-get install libhidapi-dev
```
-->
### Build `monero_c`
-Build the monero_c Library for your architecture. Follow the upstream docs at
+Build the monero_c library for your architecture. Follow the upstream docs at
https://github.com/MrCyjaneK/monero_c <!-- TODO: use example CMakeLists --> and
place the library at `monero_c/impls/monero_rust/lib/libwallet2_api_c.so` or use
the provided script:
@@ -35,8 +35,12 @@ mv release/monero/x86_64-linux-gnu_libwallet2_api_c.so ../lib/libwallet2_api_c.s
# The library should be at monero_c/impls/monero_rust/lib/libwallet2_api_c.so.
```
-### Run `monero_rust` example
+### Run `monero_rust` demo
From `monero_c/impls/monero_rust`:
```
cargo run
```
+
+## Using `monero_rust` in your own crate
+Refer to the `example` folder. `libwallet2_api_c.so` must be in the same
+directory as the binary (*eg.* at `example/target/debug/libwallet2_api_c.so`).