mirror of
https://github.com/wownero/wownero-cpp.git
synced 2026-10-18 15:51:34 +02:00
document build steps in readme
This commit is contained in:
@@ -1,18 +1,29 @@
|
||||
# Monero C++ Library
|
||||
|
||||
A lightweight wrapper of Monero's core c++ wallet ([wallet2.h](https://github.com/monero-project/monero/blob/master/src/wallet/wallet2.h)) with focus on ease-of-use and which conforms to the specification defined [here](https://github.com/monero-ecosystem/monero-javascript/blob/master/monero-model.pdf).
|
||||
This project is a lightweight wrapper of Monero's core c++ wallet, ([wallet2.h](https://github.com/monero-project/monero/blob/master/src/wallet/wallet2.h)), which focuses on ease-of-use and which conforms to the specification defined [here](https://github.com/monero-ecosystem/monero-javascript/blob/master/monero-model.pdf).
|
||||
|
||||
# See Also
|
||||
## Building a Dynamic / Shared Library
|
||||
|
||||
The source code in this project may be built as a dynamic or "shared" library for use on a target platform (e.g. Linux, Mac, Windows, etc). For example, the associated [Java reference implementation](https://github.com/monero-ecosystem/monero-java-rpc) depends on a dynamic library built from this project to support a wallet using JNI.
|
||||
|
||||
### Build Steps
|
||||
|
||||
1. Download the boost source code to ./external/boost-sdk
|
||||
2. Download the OpenSSL source code to ./external/openssl-sdk
|
||||
3. Build dependent libraries (boost, hidapi, libsodium, monero-core, and OpenSSL) and place .a files in corresponding folders in ./external-libs per CMakeLists.txt (todo: document/automate further)
|
||||
4. Build ./build/libmonero-cpp.dylib: `./bin/build-libmonero-java.sh`
|
||||
|
||||
## See Also
|
||||
|
||||
[Java reference implementation](https://github.com/monero-ecosystem/monero-java-rpc)
|
||||
|
||||
[JavaScript reference implementation](https://github.com/monero-ecosystem/monero-javascript)
|
||||
|
||||
## License
|
||||
### License
|
||||
|
||||
This project is licensed under MIT.
|
||||
|
||||
## Donate
|
||||
### Donate
|
||||
|
||||
<p align="center">
|
||||
<img src="donate.png" width="150" height="150"/>
|
||||
|
||||
Reference in New Issue
Block a user