Merge pull request #44 from arduino-cmake/release/v0.6

Release v0.6

Author: MrPointer

.gitignore

@@ -120,4 +120,6 @@ fabric.properties
 [Aa]ssets/*
 /examples/blink-example/Blink.cpp
 /examples/servo-knob-example/Knob.cpp
-/examples/sketch/sketch.cpp
+/examples/sketch/sketch1.cpp
+/examples/sketch/sketch2.cpp
+/docs/wiki

.travis.yml

@@ -3,40 +3,54 @@ os:
 - linux
 - osx
 env:
-- ARDUINO_SDK_VERSION=1.6.10
-- ARDUINO_SDK_VERSION=1.8.6
+  global:
+  - ARDUINO_SDK_BASE_PATH=arduino-sdk/arduino
+  matrix:
+  - ARDUINO_SDK_VERSION=1.6.10
+  - ARDUINO_SDK_VERSION=1.8.7
+cache:
+  directories:
+  - $HOME/$ARDUINO_SDK_BASE_PATH-$ARDUINO_SDK_VERSION
+if: branch != feature/appveyor-ci
 addons:
   apt:
     packages:
-    - gcc-avr
     - binutils-avr
     - avr-libc
     - avrdude
     - cmake
 before_install:
+- sdk_path="$HOME/$ARDUINO_SDK_BASE_PATH-$ARDUINO_SDK_VERSION"
+- mkdir -p "$sdk_path"
+- cd "$sdk_path/../.." # Get one level above 'arduino-sdk'
 - |
-  if [[ $TRAVIS_OS_NAME == linux ]]; then
-    export ARDUINO_SDK_FILE="arduino-$ARDUINO_SDK_VERSION-linux32.tar.xz"
-  else
-    export ARDUINO_SDK_FILE="arduino-$ARDUINO_SDK_VERSION-macosx.zip"
-    brew install cmake
+  if [[ -z "$(ls -A "$sdk_path")" ]];
+  then
+    if [[ $TRAVIS_OS_NAME == linux ]]; then
+      sdk_file="arduino-$ARDUINO_SDK_VERSION-linux64.tar.xz"
+    else
+      sdk_file="arduino-$ARDUINO_SDK_VERSION-macosx.zip"
+    fi
+    wget "https://downloads.arduino.cc/$sdk_file" -O "$sdk_file"
+    if [[ $TRAVIS_OS_NAME == linux ]]; then
+      tar -xf "$sdk_file" -C arduino-sdk
+    else
+      unzip -q "$sdk_file"
+      mv Arduino.app/* arduino-sdk/arduino-$ARDUINO_SDK_VERSION
+    fi
   fi
-- wget "https://downloads.arduino.cc/$ARDUINO_SDK_FILE" -O "$ARDUINO_SDK_FILE"
-- mkdir arduino-sdk
 - |
-  if [[ $TRAVIS_OS_NAME == linux ]]; then
-    tar xf "$ARDUINO_SDK_FILE" -C arduino-sdk --strip-components 1
-    export ARDUINO_SDK_PATH="$(pwd)/arduino-sdk"
-  else
-    unzip "$ARDUINO_SDK_FILE" "Arduino.app/Contents/Java/*" -d arduino-sdk
-    export ARDUINO_SDK_PATH="$(pwd)/arduino-sdk/Arduino.app/Contents/Java"
+  if [[ $TRAVIS_OS_NAME == osx ]]; then
+    sdk_path="$sdk_path/Contents/Java"
   fi
+- export ARDUINO_SDK_PATH="$sdk_path"
 install:
+- cd "$TRAVIS_BUILD_DIR"
 - mkdir build
 - rm -rf build/*
 - cd build/
 script:
-- cmake -D CMAKE_TOOLCHAIN_FILE="../cmake/Arduino-Toolchain.cmake" ..
+- cmake -D CMAKE_TOOLCHAIN_FILE="../cmake/Arduino-Toolchain.cmake" ../examples
 - make
-after_script:
+after_failure:
 - cat CMakeFiles/CMakeOutput.log

AUTHORS.md

@@ -2,8 +2,11 @@
 
 This files lists all the authors of this project that helped it grow by adding code, fixing bugs, etc.
 
-- Tomasz Bogdal ([queezythegreat - Original author of **Arduino-CMake**)
-- Timor Gruber ([MrPointer](https://github.com/MrPointer) - Author of **Arduino-CMake 3**, Current Maintainer)
+- [Tomasz Bogdal](https://github.com/queezythegreat) - Original author of **Arduino-CMake**
+- [Timor Gruber](https://github.com/MrPointer) - Author of **Arduino-CMake-NG**, Current Maintainer
+- [Tao Yuan](https://github.com/taoyuan)
+- [Mike Machado](https://github.com/machadolab)
+- [ooxi](https://github.com/ooxi)
 
 There are many other authors who have contributed to the various forks and versions, work which couldn't be done without them.
 

CHANGELOG.md

@@ -1,9 +1,59 @@
 # Change Log
 
+## Version 0.6
+
+This is a **BIG** version including numerous bug fixes, changes and even some new features.  
+It mostly addressed *3rd Party Libraries*.
+
+### New Features
+
+* 3rd Party Arduino libraries can now be manually added from any path using the `add_arduino_library` function or automatically found using the `find_arduino_library` function.  
+  To use the *find API*, the `3RD_PARTY` argument option should be passed to the function.
+
+* Header-only Arduino libraries are now supported - They can be manually added using the `add_arduino_header_only_library` function or automatically found using the `find_arduino_library` function.  
+  To use the *find API*, the`HEADER_ONLY` argument option should be pass to the function.
+
+* Full Arduino IDE *Sketchbook* support - Libraries, examples and sketches can be optionally searched there as well.  
+  The framework can also automatically find the *Sketchbook Location*, however, this is disabled by default, what also means that unless set otherwise, the framework ***doesn't search the sketchbook*** - This policy is set due to the unwanted dependency on the Arduino IDE for this feature to fully work.  
+  Further information can be found in the documentation.
+* Many improvements to the CI platforms **AppVeyor** and **Travis CI**, including:
+  * Cached builds - Decreased build time significantly
+  * Improved control-flow and readability
+
+### Bug Fixes
+
+* All functions that were expecting a theoretically "unlimited" list of sources to operate on, such as `add_arduino_executable`, `add_arduino_library` etc. couldn't parse more than one file which also was the first.
+* The `Linux-Dist-Detection` module didn't check whether the required dependencies for the detection are installed.
+* 3rd Party libraries that don't include a **library.properties** file couldn't be used.
+* 3rd Party libraries have been renamed to an "Arduino-Compliant" name when attempting to find them using the `find_arduino_library` function, which renamed them to an invalid name.
+* 3rd Party libraries that have been added using custom CMake logic (Calls to `add_library`) didn't get any of the build flags that every Arduino library has to have.
+* The framework couldn't automatically find the Arduino SDK on OS X images.
+
+### Changes
+
+* Updated project's workflow model, which mostly modifies the development branch from now on to be the **master** branch, instead of **develop**. More can be read in the **CONTRIBUTING.md** file.
+
+* The `Find-SDK` module now searches for the **version.txt** file under a sub-directory named **lib**, which resides directly under SDK's root path. This file's path is common across all OSs, unlike the previously searched **arduino** program.
+
+* The `find_arduino_library` function now searches under the following paths:
+
+  * `ARDUINO_SDK_LIBRARIES_PATH` - Usually the **libraries** directory under the SDK's root directory
+  * *Sketchbook Location* - **Arduino IDE**'s *Sketchbook* path, storing all user-downloaded libraries
+  * `CMAKE_CURRENT_SOURCE_DIRECTORY` - The directory in which the executed **CMakeLists.txt** file resides, i.e. Project's source directory
+  * `PROJECT_SOURCE_DIR` - The directory in which the **CMakeLists.txt** file that sets the `project` resides.
+
+  Besides,  the following sub-directories are searched under every path mentioned above:
+
+  - **libraries**
+  - **dependencies**
+
+* 3rd Party Arduino Libraries do not longer have to include the **library.properties** file in their root directory - Their root directory is searched instead.  
+  Nevertheless including the file is still ***recommended***, because when the file isn't present, the framework can't infer potentially required metadata from it.
+
 ## Version 0.5.2
 
-This version adds case-insensitive support for examples, forgotten in the last version.
-Fixes a bug in Core-Lib target creation on Debian/Ubuntu systems, and adds support for **AppVeyor** CI.
+This version adds case-insensitive support for examples, forgotten in the last version.  
+Fixes a bug in Core-Lib target creation on Debian/Ubuntu systems, and adds support for **AppVeyor** CI.  
 
 But most importantly - It changes the way users should supply a custom SDK location.
 
@@ -23,7 +73,7 @@ But most importantly - It changes the way users should supply a custom SDK locat
 
 ## Version 0.5.1
 
-This version fixes some "invisible" bugs from previous versions, along with general design improvements.
+This version fixes some "invisible" bugs from previous versions, along with general design improvements.  
 Moreover, there are even some new minor features.
 
 ### New Features
@@ -48,7 +98,7 @@ This version refactored the Sketch API entirely to enhance support for missing f
 
 - Headers included in a sketch file are now resolved to provide better insight
   - Arduino/Platform libraries that are resolved from a sketch's headers are linked to the target
-- Option/Policy to "forcefully" convert a sketch to a source file when adding it to a target, even if the source file already exists (Usually means that sketch has already been converted). 
+- Option/Policy to "forcefully" convert a sketch to a source file when adding it to a target, even if the source file already exists (Usually means that sketch has already been converted).   
   By default it's set to **OFF**.
 
 ### Changes
@@ -74,15 +124,15 @@ This version mostly added support for examples and sketches.
 
 * Arduino examples such as **Blink** can now be used by calling the `add_arduino_example` function
 * Arduino library examples, each being part of an Arduino library, can also be used by calling the `add_arduino_library_example` function
-* Arduino Sketches can be converted into source files under the project's source directory.
+* Arduino Sketches can be converted into source files under the project's source directory.  
   The API to use them seamlessly as using examples is still missing, however.
-* During platform initialization the main header of the platform gets selected.
-  This is useful for sketch conversion, as sketches usually don't include the header in their source files but depend on the **Arduino IDE** to do so instead.
+* During platform initialization the main header of the platform gets selected.  
+  This is useful for sketch conversion, as sketches usually don't include the header in their source files but depend on the **Arduino IDE** to do so instead.  
   The header is selected based on the number of `#include` lines it has - The header with most includes is selected as platform's main header, as it probably includes many other platform headers.
 
 ### Changes
 
-* The API of the utility function `list_replace` now resembles CMake's List API.
+* The API of the utility function `list_replace` now resembles CMake's List API.  
   It's also a macro now instead of a function.
 * Improved logic and performance of utility `increment` and `decrement` math functions
 
@@ -102,17 +152,17 @@ This version added support for Arduino libraries and platform libraries.
 
 * Arduino libraries can be found by calling `find_arduino_library` and then linked to another target by calling `link_arduino_library`
   * The library search process is architecture-aware, meaning that only sources that match the platform's architecture will be included in the library target
-* Arduino platform libraries can be simply linked to another target by calling `link_platform_library`.
+* Arduino platform libraries can be simply linked to another target by calling `link_platform_library`.  
   There's no special search process for platform libraries as there is for Arduino libraries.
 
 ## Version 0.2
 
-This version added support for the **Core Library** - A static library built from the platform's core sources that must be linked to every single target in the Arduino build system, including libraries in the future.
+This version added support for the **Core Library** - A static library built from the platform's core sources that must be linked to every single target in the Arduino build system, including libraries in the future.  
 This library is also the missing piece for getting correct program sizes, which hasn't been the case up until now.
 
 ### New Features
 
-* The Core Library is added once per board (As a board has a single associated core) and linked against every created target.
+* The Core Library is added once per board (As a board has a single associated core) and linked against every created target.  
   This behavior is internal and not up to the control of the user, much like a Kernel.
 
 ### Changes
@@ -128,13 +178,13 @@ This version added support for displaying a program's size upon build completion
 
 ### New Features
 
-* Program size output for every executable target at the end of each successful build.
-  This is done using Arduino's **avr-size** tool.
+* Program size output for every executable target at the end of each successful build.  
+  This is done using Arduino's **avr-size** tool.  
   The tool's output is then reformatted to match the format of Arduino IDE.
 
 ## Version 0.1
 
-This is the bare metal version of the framework, adding support for the very basic stuff.
+This is the bare metal version of the framework, adding support for the very basic stuff.  
 Although basic, there's a lot that had to be done in order to reach a somewhat "stable" version that can be burned to the board and actually work.
 
 ### Features