Skip to content

Commit c6d6364

Browse files
committed
updated readme
1 parent 30ffd94 commit c6d6364

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,46 @@ Minter C++ SDK: build and sign any transaction, generate mnemonic with private a
1111
* Generating mnemonic (with low-predictable [PCG](http://www.pcg-random.org/) random generator)
1212

1313
## Requirements:
14-
* GCC 4.9+/CLang/AppleClang
15-
* Boost (Multiprecision) 1.69.0 (if using raw library without **Conan**)
14+
* GCC 4.9+/Clang/AppleClang
1615
* CMake 3.10+
1716
* Python with PIP
1817
* Conan
1918

20-
## Conan setup:
19+
## Install Conan (dependency manager for C++)
20+
21+
**Debian**
22+
```bash
23+
apt-get install python3 python3-pip
24+
pip3 install setuptools -U
25+
pip3 install conan
26+
```
27+
28+
**Centos**
29+
```bash
30+
yum install python pip
31+
pip install --upgrade pip
32+
pip install setuptools -U
33+
pip install conan
34+
```
35+
36+
**Fedora (or like)**
37+
```bash
38+
dnf install python3 python3-pip
39+
pip3 install setuptools -U
40+
pip3 install conan
41+
```
42+
43+
**Setup repositories**
44+
2145
```bash
2246
conan remote add scatter https://api.bintray.com/conan/edwardstock/scatter
2347
conan remote add bincrafters https://api.bintray.com/conan/bincrafters/public-conan
2448
conan remote add minter https://api.bintray.com/conan/minterteam/minter
2549
```
2650

27-
See conan [docs](https://docs.conan.io/en/latest/getting_started.html)
51+
For more information, see official [docs](https://docs.conan.io/en/latest/getting_started.html)
2852

29-
## Build with conan
53+
## Use as conan dependency
3054
You can just add to your conanfile.txt dependency:
3155

3256
`minter_tx/0.1.0@minter/latest`
@@ -37,7 +61,9 @@ add_executable(my_program my_program.cpp)
3761
target_link_libraries(my_program CONAN_PKG::minter_tx)
3862
```
3963

40-
## Build system-wide:
64+
See [guide](https://docs.conan.io/en/latest/howtos/cmake_launch.html) how to use conan with cmake
65+
66+
## Build library:
4167
```bash
4268
git clone --recursive https://github.com/MinterTeam/cpp-minter.git
4369
mkdir build && cd build
@@ -54,3 +80,9 @@ g++ my_program.cpp -lminter_tx
5480
## Examples:
5581
See here [link](examples)
5682

83+
## License
84+
[MIT License](LICENSE)
85+
86+
Copyright (c) 2019 Minter
87+
Author: [Eduard Maximovich](https://github.com/edwardstock)
88+

0 commit comments

Comments
 (0)