Skip to content

Commit 0e71550

Browse files
authored
Update README.md
Clean up the discussion of the library name in the introduction.
1 parent ca79f83 commit 0e71550

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,11 @@
3535

3636
## Introduction
3737

38-
This repository contains the IBM LMIC (LoRaWAN-MAC-in-C) library, slightly
38+
The "Arduino LMIC" repository contains the IBM LMIC (LoRaWAN-MAC-in-C) library, slightly
3939
modified to run in the Arduino environment, allowing using the SX1272,
4040
SX1276, SX126x transceivers and compatible modules (such as some HopeRF RFM9x
4141
modules and the Murata ABZ and 1SJ LoRa modules).
4242

43-
> Note on names: the library was originally ported to Arduino by Matthijs Kooijman and Thomas Telkamp, and was named Arduino LMIC. Subsequently, MCCI did a lot of work to support other regions, and ultimately took over maintenance. The Arduino IDE doesn't like two libraries with the same name, so we had to come up with a new name. So in the IDE, it will appear as MCCI LoRaWAN LMIC Library; but all us know it by the primary header file, which is `<arduino_lmic.h>`.
44-
4543
Information about the LoRaWAN protocol is summarized in [LoRaWAN-at-a-glance](doc/LoRaWAN-at-a-glance.pdf). Full information is available from the [LoRa Alliance](https://lora-alliance.org).
4644

4745
For support, please open an entry in the [GitHub Discussions](https://github.com/mcci-catena/arduino-lmic/discussions) tab of the LMIC page on github.
@@ -57,6 +55,8 @@ The examples in this library (apart from the compliance sketch) are somewhat pri
5755

5856
Although the wrappers in this library are designed to make the LMIC useful in the Arduino environment, the maintainers have tried to be careful to keep the core LMIC code generally useful. For example, I use this library without modification (but with wrappers) on a RISC-V platform in a non-Arduino environment.
5957

58+
> Note on names: the library was originally ported to Arduino by Matthijs Kooijman and Thomas Telkamp, and was named Arduino LMIC. Subsequently, MCCI did a lot of work to support other regions, and ultimately took over maintenance. The Arduino IDE doesn't like two libraries with the same name, so we had to come up with a new name. In the IDE, this library appears as "MCCI LoRaWAN LMIC Library"; but we all know it by its primary header file, which is `<arduino_lmic.h>`.
59+
6060
## Installing
6161

6262
To install this library:

0 commit comments

Comments
 (0)