Skip to content

Commit 3b37ec1

Browse files
committed
update readme
1 parent 24f9354 commit 3b37ec1

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
**Arduino CMake toolchain** is a CMake toolchain for cross-compiling CMake based projects for all Arduino compatible boards (AVR, ESP32 etc.). Of course, this means all the benefits of CMake for Arduino compilation, like using your favourite IDE, configuration checks (e.g. `try_compile`, `CheckTypeSize`), etc. This also brings the Arduino compilation to professional users, who are limited by the Arduino IDE compilation.
44

5+
## Note by technyon
6+
7+
This is a fork of
8+
9+
https://github.com/a9183756-gh/Arduino-CMake-Toolchain
10+
11+
The original projects seems to be not maintained anymore. As far as I have tested, it
12+
only works with the Arduino ESP32 core up to version 1.6. I've merged a full open
13+
pull requests from the original project to get compatibility with Core 2.0.3
14+
(latest at the time of writing).<br>
15+
The included fixes are:
16+
17+
- https://github.com/a9183756-gh/Arduino-CMake-Toolchain/pull/53
18+
- https://github.com/a9183756-gh/Arduino-CMake-Toolchain/pull/57
19+
- Generate build_opts.h file in cmake binary dear to pass cpp compiler check
20+
521
## Project Roots
622

723
[Arduino-CMake-NG](https://github.com/arduino-cmake/Arduino-CMake-NG) is a great project, which could have prevented me from writing yet another Arduino CMake toolchain. However, as claimed by the project, Arduino-CMake-NG could not be easily utilized/modified for other Arduino compatible boards other than AVR, like ESP32, due to the fact that it does not fully work the way Arduino IDE works and has lot of AVR specific stuff. An other important limitation is related to portability. Arduino-CMake-NG provides Arduino specific CMake interface, requiring CMake scripts to be written/modified specifically for Arduino, rather than just passing `-D CMAKE_TOOLCHAIN_FILE=/path/to/Arduino-toolchain.cmake` to a generic CMake project.

0 commit comments

Comments
 (0)