Skip to content

Commit 7be0371

Browse files
README: add info about building, installing & tests
1 parent 0a596c9 commit 7be0371

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,42 @@ IEEE 802.15.4-2020).
88
At the moment, this is mostly a proof-of-concept and only FSK
99
modulation is supported.
1010

11+
Building & Installation
12+
=======================
13+
14+
To build `gr-wisun`, run these commands:
15+
16+
```
17+
mkdir build
18+
cd build
19+
cmake -DCMAKE_INSTALL_PREFIX=/path/to/install-dir ..
20+
make
21+
```
22+
23+
Once built, installing is done with:
24+
25+
```
26+
make install
27+
sudo ldconfig
28+
```
29+
30+
Tests
31+
=====
32+
33+
The directory `python/wisun` contains unit tests for each block. They
34+
can be executed with the following command (after doing the
35+
build-steps above):
36+
37+
```
38+
make test
39+
```
40+
41+
An individual test can be executed with `ctest`, e.g.:
42+
43+
```
44+
ctest --output-on-failure -R rssi_tag_cc
45+
```
46+
1147
Examples
1248
========
1349

0 commit comments

Comments
 (0)