Skip to content

Commit 474332a

Browse files
committed
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.
1 parent b3a8cca commit 474332a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+3
-16
lines changed

README

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,10 @@ This library was inspired by the SerialIP implementation by Adam Nielsen <malvin
1414
Installation
1515
------------
1616

17-
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.
17+
- Download the "Source code (zip)" of the latest "for Arduino 1.5.x" release from https://github.com/ntruchsess/arduino_uip/releases
18+
- (In the Arduino IDE) Sketch > Include Library > Add .ZIP Library... > select the downloaded file > Open
1819

19-
C:\> cd [path to Arduino distribution]\libraries
20-
C:\> git clone https://github.com/ntruchsess/arduino_uip UIPEthernet
21-
22-
Be sure to restart the IDE if it was running.
23-
24-
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).
25-
26-
$ cd ~/Documents/Arduino/libraries
27-
$ git clone https://github.com/ntruchsess/arduino_uip UIPEthernet
28-
29-
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.
30-
31-
If you are running Arduino-IDE 1.5.x use release-version 1.59 or checkout branch 'Arduino_1.5.x'
32-
33-
Additional information can be found on the Arduino website: http://www.arduino.cc/en/Hacking/Libraries
20+
Additional information can be found on the Arduino website: https://www.arduino.cc/en/Guide/Libraries
3421

3522
Documentation
3623
-------------
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)