From 92ec88edef281710883521ee6cb5de0e9bf90a54 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sun, 17 Jun 2018 19:35:46 -0700 Subject: [PATCH] Move library to root of repository A popular library installation technique is to download the library via GitHub's Clone or download > Download ZIP and then use the Arduino IDE's Sketch > Include Library > Add .ZIP Library on the downloaded file. This requires the library to be in the root of the repository, not in a subfolder. If the library is not in the root of the repository this installation technique fails: Specified folder/zip file does not contain a valid library This move is also required if you wanted to add your library to the Arduino Library Manager index, which provides an even easier installation option. --- LibAPRS/AFSK.cpp => AFSK.cpp | 0 LibAPRS/AFSK.h => AFSK.h | 0 LibAPRS/AX25.cpp => AX25.cpp | 0 LibAPRS/AX25.h => AX25.h | 0 LibAPRS/CRC-CCIT.c => CRC-CCIT.c | 0 LibAPRS/CRC-CCIT.h => CRC-CCIT.h | 0 LibAPRS/FIFO.h => FIFO.h | 0 LibAPRS/HDLC.h => HDLC.h | 0 LibAPRS/LICENSE => LICENSE | 0 LibAPRS/LibAPRS.cpp => LibAPRS.cpp | 0 LibAPRS/LibAPRS.h => LibAPRS.h | 0 README.md | 3 ++- LibAPRS/constants.h => constants.h | 0 LibAPRS/device.h => device.h | 0 {LibAPRS/examples => examples}/Basic_usage/Basic_usage.ino | 0 15 files changed, 2 insertions(+), 1 deletion(-) rename LibAPRS/AFSK.cpp => AFSK.cpp (100%) rename LibAPRS/AFSK.h => AFSK.h (100%) rename LibAPRS/AX25.cpp => AX25.cpp (100%) rename LibAPRS/AX25.h => AX25.h (100%) rename LibAPRS/CRC-CCIT.c => CRC-CCIT.c (100%) rename LibAPRS/CRC-CCIT.h => CRC-CCIT.h (100%) rename LibAPRS/FIFO.h => FIFO.h (100%) rename LibAPRS/HDLC.h => HDLC.h (100%) rename LibAPRS/LICENSE => LICENSE (100%) rename LibAPRS/LibAPRS.cpp => LibAPRS.cpp (100%) rename LibAPRS/LibAPRS.h => LibAPRS.h (100%) rename LibAPRS/constants.h => constants.h (100%) rename LibAPRS/device.h => device.h (100%) rename {LibAPRS/examples => examples}/Basic_usage/Basic_usage.ino (100%) diff --git a/LibAPRS/AFSK.cpp b/AFSK.cpp similarity index 100% rename from LibAPRS/AFSK.cpp rename to AFSK.cpp diff --git a/LibAPRS/AFSK.h b/AFSK.h similarity index 100% rename from LibAPRS/AFSK.h rename to AFSK.h diff --git a/LibAPRS/AX25.cpp b/AX25.cpp similarity index 100% rename from LibAPRS/AX25.cpp rename to AX25.cpp diff --git a/LibAPRS/AX25.h b/AX25.h similarity index 100% rename from LibAPRS/AX25.h rename to AX25.h diff --git a/LibAPRS/CRC-CCIT.c b/CRC-CCIT.c similarity index 100% rename from LibAPRS/CRC-CCIT.c rename to CRC-CCIT.c diff --git a/LibAPRS/CRC-CCIT.h b/CRC-CCIT.h similarity index 100% rename from LibAPRS/CRC-CCIT.h rename to CRC-CCIT.h diff --git a/LibAPRS/FIFO.h b/FIFO.h similarity index 100% rename from LibAPRS/FIFO.h rename to FIFO.h diff --git a/LibAPRS/HDLC.h b/HDLC.h similarity index 100% rename from LibAPRS/HDLC.h rename to HDLC.h diff --git a/LibAPRS/LICENSE b/LICENSE similarity index 100% rename from LibAPRS/LICENSE rename to LICENSE diff --git a/LibAPRS/LibAPRS.cpp b/LibAPRS.cpp similarity index 100% rename from LibAPRS/LibAPRS.cpp rename to LibAPRS.cpp diff --git a/LibAPRS/LibAPRS.h b/LibAPRS.h similarity index 100% rename from LibAPRS/LibAPRS.h rename to LibAPRS.h diff --git a/README.md b/README.md index 4a76349..e8af8a6 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,8 @@ See the example included in the library for info on how to use it! ## Installation -Place the "LibAPRS" folder (the one in the same folder as this readme file) inside your Arduino "libraries" folder. That's all! +1. Download the library: https://github.com/markqvist/LibAPRS/archive/master.zip +1. (In the Arduino IDE) Sketch > Include Library > Add .ZIP Library... > select the downloaded file > Open ## Getting started diff --git a/LibAPRS/constants.h b/constants.h similarity index 100% rename from LibAPRS/constants.h rename to constants.h diff --git a/LibAPRS/device.h b/device.h similarity index 100% rename from LibAPRS/device.h rename to device.h diff --git a/LibAPRS/examples/Basic_usage/Basic_usage.ino b/examples/Basic_usage/Basic_usage.ino similarity index 100% rename from LibAPRS/examples/Basic_usage/Basic_usage.ino rename to examples/Basic_usage/Basic_usage.ino