update readme

This commit is contained in:
woodser
2019-08-08 21:20:43 -04:00
parent f684ae0a4b
commit 3cb9f932b7
+16 -5
View File
@@ -1,10 +1,21 @@
# Monero C++ Library
This project is a lightweight wrapper of [Monero Core's](https://github.com/monero-project/monero) C++ wallet, [wallet2](https://github.com/monero-project/monero/blob/master/src/wallet/wallet2.h), which conforms to the specification defined [here](https://github.com/monero-ecosystem/monero-javascript/blob/master/monero-model.pdf).
This project is a library for working with Monero wallets in C++ by wrapping [Monero Core's](https://github.com/monero-project/monero) C++ wallet, [wallet2](https://github.com/monero-project/monero/blob/master/src/wallet/wallet2.h).
The purpose of this library is to define common daemon and wallet types for a general-purpose Monero API which focuses on ease-of-use.
In addition, this project conforms to an [API specification](https://github.com/monero-ecosystem/monero-java/blob/master/monero-spec.pdf) intended to be intuitive, robust, and for long-term use in the Monero project.
This library may be used to build Monero-related GUI applications, libraries in other languages (e.g. [monero-java](https://github.com/monero-ecosystem/monero-java-rpc)), or a conformant REST/JSON-RPC API.
This library may be used to build Monero-related GUI applications, libraries in other languages (e.g. [monero-java](https://github.com/monero-ecosystem/monero-java-rpc)), or a compliant REST/JSON-RPC API.
## Main Features
- Manage a Monero wallet
- Object-oriented model with rigorous focus on ease-of-use
- Query wallet transactions, transfers, and outputs by their many attributes
- Receive notifications as a wallet is synchronized, when blocks are added to the chain, or when the wallet sends or receives transfers
## Sample Code
TODO
## Building a Dynamic / Shared Library
@@ -12,8 +23,6 @@ The source code in this project may be built as a dynamic or "shared" library fo
### Build Steps
These build steps aspire to be automated further.
1. Setup Boost
1. Download and extract the boost 1.69.0 source code zip from https://www.boost.org/users/download/ to ./external/boost-sdk/.
2. `cd ./external/boost-sdk/`
@@ -42,6 +51,8 @@ These build steps aspire to be automated further.
Mac: installed through homebrew at /usr/local/Cellar/libsodium/1.0.17/lib/libsodium.a
6. Build libmonero-cpp.dylib to ./build: `./bin/build-libmonero-cpp.sh`.
These build steps aspire to be automated further.
## See Also
[Java reference implementation](https://github.com/monero-ecosystem/monero-java-rpc)