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

Commit ecedf36

Browse files
authored
Merge branch 'master' into feature/lib-without-sources
2 parents 5e28d00 + 693011c commit ecedf36

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 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)
@@ -102,16 +108,16 @@ The following list is the basic requirements of the framework in order to use it
102108
## Installation
103109

104110
First, make sure to download the [latest release](https://github.com/arduino-cmake/Arduino-CMake-NG/releases) of the framework.
105-
Further instructions can be found in the [Installation](https://github.com/arduino-cmake/arduino-cmake/wiki/Installation) Wiki page.
111+
Further instructions can be found in the [Installation](https://github.com/arduino-cmake/Arduino-CMake-NG/wiki/Installation) Wiki page.
106112

107113
## Documentation
108114

109-
The entire documentation of the project is hosted on GitHub using [Wiki pages](https://github.com/arduino-cmake/arduino-cmake/wiki).
115+
The entire documentation of the project is hosted on GitHub using [Wiki pages](https://github.com/arduino-cmake/Arduino-CMake-NG/wiki).
110116

111117
## Contributing
112118

113-
The project has strict contributing guidelines which can be found in the [Contributing File](https://github.com/arduino-cmake/arduino-cmake/blob/develop/CONTRIBUTING.md).
119+
The project has strict contributing guidelines which can be found in the [Contributing File](https://github.com/arduino-cmake/Arduino-CMake-NG/blob/master/CONTRIBUTING.md).
114120

115121
## License
116122

117-
MIT © 2018 [Arduino-CMake](https://github.com/arduino-cmake/arduino-cmake/blob/docs/LICENSE.md)
123+
MIT © 2018 [Arduino-CMake](https://github.com/arduino-cmake/Arduino-CMake-NG/blob/master/LICENSE.md)

0 commit comments

Comments
 (0)