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

Commit 693011c

Browse files
authored
Rephrased 'Readme' to state that 3rd party platform aren't supported
Also added bullets listing what the framework currently doesn't support.
1 parent 6ad9a94 commit 693011c

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
[![AppVeyor](https://img.shields.io/appveyor/ci/arduino-cmake/arduino-cmake-ng/develop.svg?label=Windows&logo=appveyor)](https://ci.appveyor.com/project/arduino-cmake/arduino-cmake-ng)[![Travis CI](https://img.shields.io/travis/arduino-cmake/Arduino-CMake-NG.svg?label=Linux%20and%20OS%20X&logo=travis)](https://travis-ci.org/arduino-cmake/Arduino-CMake-NG)
44

5-
**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**.
5+
**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 respect that (Note that it doesn't mean we support it yet).
66
In other words, developers can use their favorite IDEs or text editors on their favorite OS to develop Arduino programs!
77

88
Wait - Hasn't it been possible all this time? Apparently not. You can read more about it in the [Motivation](#Motivation) section.
99

1010
## Features
1111

12-
**Arduino-CMake** should<sup id="fl1">[1](#f1)</sup> do almost<sup id="fl2">[2](#f2)</sup> <u>anything</u> that the **Arduino IDE** does!
12+
**Arduino-CMake** should<sup id="fl1">[1](#f1)</sup> do almost<sup id="fl2">[2](#f2)</sup> <u>anything</u> that the **Arduino IDE** does!
1313
Here's a list of features **already supported** by **Arduino-CMake**:
1414

1515
- Creating Arduino "Executables"/Programs
@@ -26,6 +26,12 @@ Moreover, **Arduino-CMake** allows some things that **Arduino IDE** *doesn't*:
2626
- Developing Arduino programs in any IDE or text editor
2727
- Completely customizing the build process per user's requirements
2828

29+
What's **not** supported?
30+
31+
* 3rd Party *Platforms* such as ESP32, Pinoccio, etc.
32+
* Programmers and advanced bootloaders
33+
* Serial connection (e.g. for monitoring)
34+
2935
It's also worth mentioning that **Arduino-CMake** is **<u>cross platform</u>** and works out-of-the-box on every OS that support **CMake** and **Arduino**.
3036

3137
<b id="f1">1</b> The framework is still a WIP, meaning there are some missing features. [](#fl1)

0 commit comments

Comments
 (0)