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 is the standard repository structure used in all official Arduino libraries: https://github.com/arduino-libraries 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.
ntruchsess · Aug 24, 2018 · 474332a · 474332a
1 parent b3a8cca
commit 474332a
Show file tree

Hide file tree

Showing 44 changed files with 3 additions and 16 deletions.
diff --git a/README b/README
@@ -14,23 +14,10 @@ This library was inspired by the SerialIP implementation by Adam Nielsen <malvin
 Installation
 ------------
 
-To install the libraries, you need to place them into your "libraries" folder. You can find it within your Arduino IDE distribution within the "hardware" folder.
+ - Download the "Source code (zip)" of the latest "for Arduino 1.5.x" release from https://github.com/ntruchsess/arduino_uip/releases
+ - (In the Arduino IDE) Sketch > Include Library > Add .ZIP Library... > select the downloaded file > Open
 
-    C:\> cd [path to Arduino distribution]\libraries
-    C:\> git clone https://github.com/ntruchsess/arduino_uip UIPEthernet
-
-Be sure to restart the IDE if it was running.
-
-On a Mac, you will want to create a folder named "libraries" in in the "Documents" -> "Arduino" folder within your home directory. Clone the project there (and restart the IDE, if it was running during this process).
-
-    $ cd ~/Documents/Arduino/libraries
-    $ git clone https://github.com/ntruchsess/arduino_uip UIPEthernet
-
-Or you download the zipped version of the library from https://github.com/ntruchsess/arduino_uip/releases, and copy the contained directory UIPEthernet to [path to Arduino distribution]\libraries\UIPEthernet.
-
-If you are running Arduino-IDE 1.5.x use release-version 1.59 or checkout branch 'Arduino_1.5.x'
-
-Additional information can be found on the Arduino website: http://www.arduino.cc/en/Hacking/Libraries
+Additional information can be found on the Arduino website: https://www.arduino.cc/en/Guide/Libraries
 
 Documentation
 -------------

diff --git a/...AdvancedChatServer/AdvancedChatServer.ino → ...AdvancedChatServer/AdvancedChatServer.ino b/...AdvancedChatServer/AdvancedChatServer.ino → ...AdvancedChatServer/AdvancedChatServer.ino
diff --git a/...hernet/examples/EchoServer/EchoServer.ino → examples/EchoServer/EchoServer.ino b/...hernet/examples/EchoServer/EchoServer.ino → examples/EchoServer/EchoServer.ino
diff --git a/UIPEthernet/examples/TcpClient/TcpClient.ino → examples/TcpClient/TcpClient.ino b/UIPEthernet/examples/TcpClient/TcpClient.ino → examples/TcpClient/TcpClient.ino
diff --git a/UIPEthernet/examples/TcpServer/TcpServer.ino → examples/TcpServer/TcpServer.ino b/UIPEthernet/examples/TcpServer/TcpServer.ino → examples/TcpServer/TcpServer.ino
diff --git a/UIPEthernet/examples/UdpClient/UdpClient.ino → examples/UdpClient/UdpClient.ino b/UIPEthernet/examples/UdpClient/UdpClient.ino → examples/UdpClient/UdpClient.ino
diff --git a/UIPEthernet/examples/UdpServer/UdpServer.ino → examples/UdpServer/UdpServer.ino b/UIPEthernet/examples/UdpServer/UdpServer.ino → examples/UdpServer/UdpServer.ino
diff --git a/UIPEthernet/keywords.txt → keywords.txt b/UIPEthernet/keywords.txt → keywords.txt
diff --git a/UIPEthernet/library.properties → library.properties b/UIPEthernet/library.properties → library.properties
diff --git a/UIPEthernet/src/Dhcp.cpp → src/Dhcp.cpp b/UIPEthernet/src/Dhcp.cpp → src/Dhcp.cpp
diff --git a/UIPEthernet/src/Dhcp.h → src/Dhcp.h b/UIPEthernet/src/Dhcp.h → src/Dhcp.h
diff --git a/UIPEthernet/src/Dns.cpp → src/Dns.cpp b/UIPEthernet/src/Dns.cpp → src/Dns.cpp
diff --git a/UIPEthernet/src/Dns.h → src/Dns.h b/UIPEthernet/src/Dns.h → src/Dns.h
diff --git a/UIPEthernet/src/UIPClient.cpp → src/UIPClient.cpp b/UIPEthernet/src/UIPClient.cpp → src/UIPClient.cpp
diff --git a/UIPEthernet/src/UIPClient.h → src/UIPClient.h b/UIPEthernet/src/UIPClient.h → src/UIPClient.h
diff --git a/UIPEthernet/src/UIPEthernet.cpp → src/UIPEthernet.cpp b/UIPEthernet/src/UIPEthernet.cpp → src/UIPEthernet.cpp
diff --git a/UIPEthernet/src/UIPEthernet.h → src/UIPEthernet.h b/UIPEthernet/src/UIPEthernet.h → src/UIPEthernet.h
diff --git a/UIPEthernet/src/UIPServer.cpp → src/UIPServer.cpp b/UIPEthernet/src/UIPServer.cpp → src/UIPServer.cpp
diff --git a/UIPEthernet/src/UIPServer.h → src/UIPServer.h b/UIPEthernet/src/UIPServer.h → src/UIPServer.h
diff --git a/UIPEthernet/src/UIPUdp.cpp → src/UIPUdp.cpp b/UIPEthernet/src/UIPUdp.cpp → src/UIPUdp.cpp
diff --git a/UIPEthernet/src/UIPUdp.h → src/UIPUdp.h b/UIPEthernet/src/UIPUdp.h → src/UIPUdp.h
diff --git a/UIPEthernet/src/ethernet_comp.h → src/ethernet_comp.h b/UIPEthernet/src/ethernet_comp.h → src/ethernet_comp.h
diff --git a/UIPEthernet/src/utility/Enc28J60Network.cpp → src/utility/Enc28J60Network.cpp b/UIPEthernet/src/utility/Enc28J60Network.cpp → src/utility/Enc28J60Network.cpp
diff --git a/UIPEthernet/src/utility/Enc28J60Network.h → src/utility/Enc28J60Network.h b/UIPEthernet/src/utility/Enc28J60Network.h → src/utility/Enc28J60Network.h
diff --git a/UIPEthernet/src/utility/clock-arch.c → src/utility/clock-arch.c b/UIPEthernet/src/utility/clock-arch.c → src/utility/clock-arch.c
diff --git a/UIPEthernet/src/utility/clock-arch.h → src/utility/clock-arch.h b/UIPEthernet/src/utility/clock-arch.h → src/utility/clock-arch.h
diff --git a/UIPEthernet/src/utility/enc28j60.h → src/utility/enc28j60.h b/UIPEthernet/src/utility/enc28j60.h → src/utility/enc28j60.h
diff --git a/UIPEthernet/src/utility/mempool.cpp → src/utility/mempool.cpp b/UIPEthernet/src/utility/mempool.cpp → src/utility/mempool.cpp
diff --git a/UIPEthernet/src/utility/mempool.h → src/utility/mempool.h b/UIPEthernet/src/utility/mempool.h → src/utility/mempool.h
diff --git a/UIPEthernet/src/utility/mempool_conf.h → src/utility/mempool_conf.h b/UIPEthernet/src/utility/mempool_conf.h → src/utility/mempool_conf.h
diff --git a/UIPEthernet/src/utility/uip-conf.h → src/utility/uip-conf.h b/UIPEthernet/src/utility/uip-conf.h → src/utility/uip-conf.h
diff --git a/UIPEthernet/src/utility/uip.c → src/utility/uip.c b/UIPEthernet/src/utility/uip.c → src/utility/uip.c
diff --git a/UIPEthernet/src/utility/uip.h → src/utility/uip.h b/UIPEthernet/src/utility/uip.h → src/utility/uip.h
diff --git a/UIPEthernet/src/utility/uip_arch.h → src/utility/uip_arch.h b/UIPEthernet/src/utility/uip_arch.h → src/utility/uip_arch.h
diff --git a/UIPEthernet/src/utility/uip_arp.c → src/utility/uip_arp.c b/UIPEthernet/src/utility/uip_arp.c → src/utility/uip_arp.c
diff --git a/UIPEthernet/src/utility/uip_arp.h → src/utility/uip_arp.h b/UIPEthernet/src/utility/uip_arp.h → src/utility/uip_arp.h
diff --git a/UIPEthernet/src/utility/uip_clock.h → src/utility/uip_clock.h b/UIPEthernet/src/utility/uip_clock.h → src/utility/uip_clock.h
diff --git a/UIPEthernet/src/utility/uip_debug.cpp → src/utility/uip_debug.cpp b/UIPEthernet/src/utility/uip_debug.cpp → src/utility/uip_debug.cpp
diff --git a/UIPEthernet/src/utility/uip_debug.h → src/utility/uip_debug.h b/UIPEthernet/src/utility/uip_debug.h → src/utility/uip_debug.h
diff --git a/UIPEthernet/src/utility/uip_timer.c → src/utility/uip_timer.c b/UIPEthernet/src/utility/uip_timer.c → src/utility/uip_timer.c
diff --git a/UIPEthernet/src/utility/uip_timer.h → src/utility/uip_timer.h b/UIPEthernet/src/utility/uip_timer.h → src/utility/uip_timer.h
diff --git a/UIPEthernet/src/utility/uipethernet-conf.h → src/utility/uipethernet-conf.h b/UIPEthernet/src/utility/uipethernet-conf.h → src/utility/uipethernet-conf.h
diff --git a/UIPEthernet/src/utility/uipopt.h → src/utility/uipopt.h b/UIPEthernet/src/utility/uipopt.h → src/utility/uipopt.h
diff --git a/UIPEthernet/src/utility/util.h → src/utility/util.h b/UIPEthernet/src/utility/util.h → src/utility/util.h