Skip to content

Commit c72012d

Browse files
Document config.h in README
1 parent 0df8403 commit c72012d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,18 @@ What has not been tested:
4848
If you try one of these untested features and it works, be sure to let
4949
us know (creating a github issue is probably the best way for that).
5050

51+
Configuration
52+
-------------
53+
A number of features can be configured or disabled by editing the
54+
`config.h` file in the library folder. Unfortunately the Arduino
55+
environment does not offer any way to do this (compile-time)
56+
configuration from the sketch, so be careful to recheck your
57+
configuration when you switch between sketches or update the library.
58+
59+
At the very least, you should set the right type of transceiver (SX1272
60+
vs SX1276) in config.h, most other values should be fine at their
61+
defaults.
62+
5163
Supported hardware
5264
------------------
5365
This library is intended to be used with plain LoRa transceivers,

0 commit comments

Comments
 (0)