xref: /libbtbb/README.md (revision 37c736c494b9fe5ca44e1a11131cb074a4158161)
1libbtbb
2=======
3
4This is the Bluetooth baseband decoding library, forked from the GR-Bluetooth
5project.  It can be used to extract Bluetooth packet and piconet information
6from Ubertooth devices as well as GR-Bluetooth/USRP.
7
8This code is incomplete, it is still under active development.  Patches and
9bug reports should be submitted to the bug tracker on GitHub:
10https://github.com/greatscottgadgets/libbtbb/issues
11
12This software has been developed and tested on Linux, it should work on other
13platforms but this has yet to be tested.
14
15
16Build Instructions
17==================
18
19Libbtbb can be built and installed as follows:
20```
21$ mkdir build
22$ cd build
23$ cmake ..
24$ make
25$ sudo make install
26```
27
28This will install the library to /usr/local/lib and the headers to
29/usr/local/include, to install to different locations use:
30```
31$ cmake -DINSTALL_DIR=/path/to/install -DINCLUDE_DIR=/path/to/include ..
32```
33
34If you have previous versions of libbtbb, libubertooth or the Ubertooth tools
35installed, you can use the cleanup script to remove them:
36```
37$ sudo cmake/cleanup.sh -d
38```
39
40To list the installed files without removing them, use:
41```
42$ cmake/cleanup.sh
43```
44