Skip to content

Commit aa1fdea

Browse files
author
Bedeho Mender
authored
Create README.md
1 parent aa58eb4 commit aa1fdea

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# protocol_wire-cpp
2+
C++ wire library for the JoyStream extension protocol, as specified [here](http://#).
3+
4+
## Tools
5+
6+
- [Conan](http://conan.io)
7+
- CMake
8+
9+
## Use
10+
11+
The easiest way to use the library in your own project is to use Conan. For more information, see the [readme](https://github.com/JoyStream/protocol_wire-conan)
12+
on the repo for this package recipe.
13+
14+
## Build
15+
16+
If you instead want to build it directly, then you first have to install the dependencies of this
17+
library using Conan, which you do by simply doing the following inside of your desired build directory
18+
19+
`conan install <path>`
20+
21+
where `<path>` is the path to protcol_wire source directory. Then, in the same directory, invoke CMake
22+
23+
```
24+
cmake <path>
25+
cmake --build .
26+
```
27+
28+
No path is required if you are building directly in the source directory.
29+
30+
## Tests
31+
32+
To build the tests, just pass option `build_tests=on` in the makefile generation step
33+
34+
```
35+
cmake <path> -Dbuild_tests=on
36+
cmake --build .
37+
```
38+
39+
and then you can run the resulting test binary `test_main` in the `bin` folder.
40+
41+
## License and copyright
42+
WIP

0 commit comments

Comments
 (0)