Skip to content

Commit 75428ae

Browse files
committed
Make the libraries compatible with the Arduino IDE
- Add library.properties files. These are required for the Arduino IDE to recognize libraries in the 1.5 format (source files under the src folder). - Move keywords.txt files to the root of the library folders. The Arduino IDE will not recognize keywords.txt files under the src folder. - Move example sketches to appropriately named folders. The Arduino IDE requires that sketches be in a folder of the same name. This change causes the examples to be accessible via the File > Examples > LIBRARYNAME menu after installing the library. - Update installation instructions.
1 parent e1e340a commit 75428ae

10 files changed

Lines changed: 25 additions & 6 deletions

File tree

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
- "~/.platformio"
3939

4040
env:
41-
- PLATFORMIO_CI_SRC=LineController/examples/LineChecker.pde
41+
- PLATFORMIO_CI_SRC=LineController/examples/LineChecker/LineChecker.pde
4242
# - PLATFORMIO_CI_SRC=examples/file.ino
4343
# - PLATFORMIO_CI_SRC=path/to/test/directory
4444

File renamed without changes.
File renamed without changes.

Hbridge/library.properties

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name=Hbridge
2+
version=0.0.1
3+
author=Daniel P. Poltronieri
4+
maintainer=Daniel P. Poltronieri
5+
sentence=Control the L293D IC and boards based on it.
6+
paragraph=
7+
category=Device Control
8+
url=https://github.com/dpoltronieri/Arduino
9+
architectures=*
10+
includes=HBridge.hpp
File renamed without changes.
File renamed without changes.

LineController/library.properties

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name=LineController
2+
version=0.0.1
3+
author=Daniel P. Poltronieri
4+
maintainer=Daniel P. Poltronieri
5+
sentence=Use digital line tracking sensors.
6+
paragraph=
7+
category=Sensors
8+
url=https://github.com/dpoltronieri/Arduino
9+
architectures=*
10+
includes=LineController.hpp

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ These libraries were initially created for the discipline Programming Languages
2828

2929
## Install
3030
More information can be found in https://www.arduino.cc/en/Guide/Libraries
31-
#### Windows
32-
Copy the desired library to `Libraries` inside the `Arduino` folder in `My Documents`.
33-
34-
#### Linux
35-
Copy the desired library to `Libraries` inside the Arduino IDE instalation folder.
31+
#### Arduino IDE
32+
1. Download the libraries: https://github.com/dpoltronieri/Arduino/archive/master.zip
33+
2. Unzip the downloaded file.
34+
3. (In the Arduino IDE) Sketch > Include Library > Add .ZIP Library > Select the library you want to install from the unzipped `Arduino-master` folder. > Open
3635

3736
#### Atom
3837
Copy the desired library to the `Lib` folder in the compilation directory.

0 commit comments

Comments
 (0)