summaryrefslogtreecommitdiff
path: root/impls/monero.rs/example/README.md
diff options
context:
space:
mode:
authorsneurlax <sneurlax@gmail.com>2024-10-29 14:31:32 -0500
committersneurlax <sneurlax@gmail.com>2024-10-29 14:31:37 -0500
commit8e7bc59509c40f00702ba568a0adcb3cf82e6e05 (patch)
tree837e2900dc9c8827511048c923e57fc12ef64d78 /impls/monero.rs/example/README.md
parent510cb144207c71dd8cc78c2fb54075aa90574158 (diff)
update docs re: lib placementrust
Diffstat (limited to 'impls/monero.rs/example/README.md')
-rw-r--r--impls/monero.rs/example/README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/impls/monero.rs/example/README.md b/impls/monero.rs/example/README.md
index e1973fe..febb9cf 100644
--- a/impls/monero.rs/example/README.md
+++ b/impls/monero.rs/example/README.md
@@ -1,21 +1,22 @@
# `monero_c/impls/monero.rs/example`
-Refer to the latest documentation at
-https://github.com/MrCyjaneK/monero_c/blob/master/README.md and
+Refer to https://github.com/MrCyjaneK/monero_c/blob/master/README.md and
https://github.com/MrCyjaneK/monero_c/blob/master/impls/monero.rs/README.md for
the latest documentation.
## `monero_c` library
-A `monero_c` library is required to use these bindings. Build or download the
+A `monero_c` library is required to build this example. 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 should then be
placed adjacent to the binary: that is, if your binary is in `target/debug` or
`target/release`, the library should also be in `release` or `debug`,
-respectively. Its name should match your platform as in:
+respectively. Its name should also 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`
-Also symlink "libmonero_libwallet2_api_c.so" and "libwallet2_api_c.so" to "monero_libwallet2_api_c.so". TODO: Test symlinking requirements on all non-Linux platforms.
+On Linux you must also symlink "libmonero_libwallet2_api_c.so" and
+"libwallet2_api_c.so" to "monero_libwallet2_api_c.so". Other systems will also
+need similar symlinks or copies.