summaryrefslogtreecommitdiff
path: root/impls/monero.rs/README.md
blob: 22a991ae62e7179fb131ea815d67c5cb3083a0e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# `monero_rust`
Proof of concept `monero_c` bindings for Rust.

## Getting started
<!--
### Prerequisites
You may need
```
sudo apt-get install libhidapi-dev
```
-->
### Build or download `monero_c` library
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`)
- `.` (as in `monero_c/impls/monero_rust/target/debug` or `release`)

### Run demo
With the library in a supported location, from `monero_c/impls/monero_rust`:
```
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/`).