Skip to content
This repository was archived by the owner on Apr 17, 2023. It is now read-only.

Commit 8b7ea11

Browse files
committed
Updated 'changelog' and 'installation' to mention ARDUINO_SDK_PATH change.
Updated 'Readme' to include new 'AppVeyor' build status badge.
1 parent e55dd7a commit 8b7ea11

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@
33
## Version 0.5.2
44

55
This version adds case-insensitive support for examples, forgotten in the last version.
6-
It also fixes a bug in Core-Lib target creation on Debian/Ubuntu systems.
6+
Fixes a bug in Core-Lib target creation on Debian/Ubuntu systems, and adds support for **AppVeyor** CI.
7+
8+
But most importantly - It changes the way users should supply a custom SDK location.
79

810
### New Features
911

1012
* Example name parameter of the **Example API** functions is now case-insensitive
13+
* Support for **AppVeyor** continuous integration/CI.
1114

1215
### Changes
1316

17+
* Supplying custom **Arduino SDK** path - Should now set an environment variable in the system named `ARDUINO_SDK_PATH`, instead of passing it as a variable to CMake through `-D`
1418
* Parameter order in the `add_arduino_library_example` function - `_board_id` becomes 2nd
1519

1620
### Bug Fixes

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Arduino-CMake NG
22

3-
[![Travis Build Status](https://img.shields.io/travis/arduino-cmake/arduino-cmake.svg?logo=travis&style=for-the-badge&label=Linux&branch=master)](https://travis-ci.org/arduino-cmake/arduino-cmake) [![AppVeyor Build Status](https://img.shields.io/appveyor/ci/arduino-cmake/arduino-cmake/master.svg?logo=appveyor&style=for-the-badge&label=Windows)](https://ci.appveyor.com/project/arduino-cmake/arduino-cmake) [![Latest Release Version](https://img.shields.io/github/release/arduino-cmake/arduino-cmake.svg?logo=github&style=for-the-badge)](https://github.com/arduino-cmake/arduino-cmake/releases)
3+
[![AppVeyor Build](https://ci.appveyor.com/api/projects/status/github/arduino-cmake/Arduino-CMake-NG?svg=true&passingText=Windows%20-%20Passing&failingText=Windows%20-%20Failing&pendingText=Windows%20-%20Pending)](https://ci.appveyor.com/project/arduino-cmake-ng/arduino-cmake-ng)
44

55
**Arduino-CMake** is a framework which allows developers to write Arduino-based programs using any tool that supports cmake. *Arduino-based*? There are many other frameworks out there built upon Arduino's base, such as ESP32, and **we support that**.
66
In other words, developers can use their favorite IDEs or text editors on their favorite OS to develop Arduino programs!
@@ -91,7 +91,7 @@ add_arduino_executable(Hello_World ${board_id} helloWorld.cpp)
9191
upload_arduino_target(Hello_World "${board_id}" COM3)
9292
```
9393

94-
You should then call **CMake** (either through the cmd, the cmake-gui or the IDE if it supports that) passing it the argument `-DCMAKE_TOOLCHAIN_FILE=[project_path]/cmake/Arduino-Toolchain.cmake` where `[project_path]` is substituted by the project's full path. This is what allows cmake to use our framework.
94+
You should then call **CMake** (either through cmd, cmake-gui or an IDE if it supports that) passing it the argument `-DCMAKE_TOOLCHAIN_FILE=[project_path]/cmake/Arduino-Toolchain.cmake` where `[project_path]` is substituted by the project's full path. This is what allows cmake to use our framework.
9595

9696
That's it! It's super simple, yet super extensible :)
9797

docs/Getting Started/Installation.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,6 @@ By default, **Arduino-CMake** looks for the Arduino SDK in the following paths,
7878

7979
##### Setting Custom Path
8080

81-
If your SDK isn't located in any of the above paths, you should pass it manually to the framework.
82-
The framework stores the path in a cache variable named `ARDUINO_SDK_PATH`.
83-
There are multiple ways to set this variable:
81+
If your SDK isn't located in any of the above paths, you should set an environment variable with the name of `ARDUINO_SDK_PATH`, pointing to the desired custom location.
8482

85-
1. Pass the variable when running CMake, like this: `cmake -DARDUINO_SDK_PATH=[PATH]` where `[PATH]` is the absolute path to the SDK. **This is the preferred way!**
86-
2. Set it manually in your main **CMakeLists.txt** file, like this: `set(ARDUINO_SDK_PATH "PATH")` where `PATH` is the absolute path to the SDK. Note that this line should appear **before** the line setting the project, which looks like `project(my_project)`.
83+
> Note that in order to persist your environmental variables you may have to perform some extra steps, depending on your OS.

0 commit comments

Comments
 (0)