Skip to content

Commit 2acfc57

Browse files
Add documentation about contributing data such as UUID descriptions (#38)
1 parent 11a51b0 commit 2acfc57

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,19 @@ that still illustrates the problem you are facing. By removing other factors,
3737
you help us to identify the root cause of the issue.
3838

3939

40+
Contributions of data
41+
=====================
42+
43+
HumBLE Explorer tries to show a human-friendly description for as much data as
44+
possible, such as descriptions of the UUIDs in Bluetooth advertisements. Not all
45+
UUIDs are known, however. If you see the program showing a UUID with the description
46+
**Unknown** and you know what the description should be, please contribute it to the
47+
`bluetooth-numbers <https://github.com/koenvervloesem/bluetooth-numbers>`_ project
48+
by opening an issue there. HumBLE Explorer uses the bluetooth-numbers library for its
49+
descriptions, and updating the bluetooth-numbers library with new descriptions will add
50+
them to HumBLE Explorer too.
51+
52+
4053
Documentation Improvements
4154
==========================
4255

0 commit comments

Comments
 (0)