summaryrefslogtreecommitdiff
path: root/impls/monero_rust/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'impls/monero_rust/README.md')
-rw-r--r--impls/monero_rust/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/impls/monero_rust/README.md b/impls/monero_rust/README.md
new file mode 100644
index 0000000..eeb3524
--- /dev/null
+++ b/impls/monero_rust/README.md
@@ -0,0 +1,40 @@
+# `monero_rust`
+`monero_c` bindings for Rust.
+
+## Getting started
+1. Build `monero_c`
+2. Copy the `monero_c` static library to `monero_rust`.
+3. Run `monero_rust` example
+
+### Build `monero_c`
+Build a monero_c static Library for your architecture. Follow the upstream docs
+at https://github.com/MrCyjaneK/monero_c or for example:
+```
+./scripts/build_monero_c.sh
+```
+<!-- TODO add param for arch -->
+
+or manually:
+```
+git clone https://git.mrcyjanek.net/sneurlax/monero_c --branch rust
+cd monero_c
+git submodule update --init --recursive
+rm -rf monero wownero release # Clean any previous builds.
+git submodule update --init --recursive --force
+./apply_patches.sh monero
+./build_single.sh monero x86_64-linux-gnu -j$(nproc)
+```
+<!-- TODO add unxz etc -->
+
+### Copy the `monero_c` static library to `monero_rust`.
+Copy your `libwallet` static library to `monero_c/impls/monero_rust/lib`.
+```
+cp build/release/monero/x86_64-linux-gnu_libwallet2_api_c.so ../lib
+```
+<!-- TODO automatically copy using arch provided as param IAW TODO above -->
+
+### Run `monero_rust` example
+From `monero_c/impls/monero_rust`:
+```
+cargo run
+```