You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+11-11
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,13 @@ Arduino is a great development platform, which is easy to use. It has everything
6
6
7
7
One major drawback of the *Arduino IDE* is that you cannot do anything without it, which for me is a **complete buzz kill**. Thats why I created an alternative build system for the Arduino using CMake.
8
8
9
-
CMake is great cross-platform build system that works on practically any operating system. With it you are not constrained to a single build system. CMake lets you generated the build system that fits your needs, using the tools you like. It can generate any type of build system, from simple Makefiles, to complete projects for Eclipse, Visual Studio, XCode, etc.
9
+
CMake is great cross-platform build system that works on practically any operating system. With it you are not constrained to a single build system. CMake lets you generate the build system that fits your needs, using the tools you like. It can generate any type of build system, from simple Makefiles, to complete projects for Eclipse, Visual Studio, XCode, etc.
10
10
11
11
The **Arduino CMake** build system integrates tightly with the *Arduino SDK*.
12
12
13
13
*Arduino SDK* version **0.19** or higher is required.
14
14
15
-
So if you like to do things from the command line (using make), or to build you're firmware where you're in control, or if you would like to use an IDE such as Eclipse, KDevelop, XCode, CodeBlocks or something similar, then **Arduino CMake** is the system for you.
15
+
So if you like to do things from the command line (using make), or to build your firmware where you're in control, or if you would like to use an IDE such as Eclipse, KDevelop, XCode, CodeBlocks or something similar, then **Arduino CMake** is the system for you.
16
16
17
17
Features
18
18
--------
@@ -35,7 +35,7 @@ Features
35
35
Feedback
36
36
--------
37
37
38
-
**Arduino CMake** is hosted on GitHUB and is available at:
38
+
**Arduino CMake** is hosted on GitHub and is available at:
39
39
40
40
https://github.com/queezythegreat/arduino-cmake
41
41
@@ -44,7 +44,7 @@ Did you find a bug or would like a specific feature, please report it at:
If you would like to hack on this project, don't hesitate to fork it on GitHub.
47
-
I will be glad to integrate you'r changes if you send me a ``Pull Request``.
47
+
I will be glad to integrate your changes if you send me a ``Pull Request``.
48
48
49
49
50
50
Requirements
@@ -191,16 +191,16 @@ For a more detailed explanation, please read on...
191
191
192
192
2. Creating a build directory
193
193
194
-
The second order of business is creating a build directory. CMake has a great feature called out-of-source builds, what this means is the building is done in a completely separate directory, than where the sources are. The benefits of this is you don't have any clutter in you source directory and you won't accidentally commit something in, that is auto-generated.
194
+
The second order of business is creating a build directory. CMake has a great feature called out-of-source builds, what this means is the building is done in a completely separate directory from where the sources are. The benefit of this is you don't have any clutter in you source directory and you won't accidentally commit something that is auto-generated.
195
195
196
-
So lets create that build directory::
196
+
So let's create that build directory::
197
197
198
198
mkdir build
199
199
cd build
200
200
201
201
3. Creating the build system
202
202
203
-
Now lets create the build system that will create our firmware::
203
+
Now let's create the build system that will create our firmware::
204
204
205
205
cmake ..
206
206
@@ -427,7 +427,7 @@ You can specify the options in two ways, either as the command arguments or as v
427
427
428
428
Where **${TARGET_NAME}** is the name of you target and **${OPTION_NAME}** is the name of the option.
429
429
430
-
Lets define a simple library called ``blink_lib``, with two sources files for the *Arduino Uno*::
430
+
Let's define a simple library called ``blink_lib`` with two sources files for the *Arduino Uno*::
431
431
432
432
set(blink_lib_SRCS blink_lib.cpp)
433
433
set(blink_lib_HDRS blink_lib.h)
@@ -442,7 +442,7 @@ The other way of defining the same thing is::
442
442
HDRS blink_lib.h
443
443
BOARD uno)
444
444
445
-
Once that library is defined we can use it in our other firmware images... Lets add ``blink_lib`` to the ``blink`` firmware::
445
+
Once that library is defined we can use it in our other firmware images... Let's add ``blink_lib`` to the ``blink`` firmware::
446
446
447
447
set(blink_SRCS blink.cpp)
448
448
set(blink_HDRS blink.h)
@@ -485,7 +485,7 @@ Any source files contained within that directory is part of the library. Here is
485
485
|-- ExampleLib.cpp
486
486
`-- OtherLibSource.cpp
487
487
488
-
Now because the power of Arduino lies within those usercreated libraries, support for them is built right into **Arduino CMake**. The **Arduino SDK** comes with a large number of default libraries, adding new libraries is simple.
488
+
Now because the power of Arduino lies within those user-created libraries, support for them is built right into **Arduino CMake**. The **Arduino SDK** comes with a large number of default libraries and adding new libraries is simple.
489
489
490
490
To incorporate a library into your firmware, you can do one of three things:
491
491
@@ -600,7 +600,7 @@ or when configuring the project::
600
600
Programmers
601
601
~~~~~~~~~~~
602
602
603
-
**Arduino CMake** fully supports programmers, for burning firmware and bootloader images directly onto the Arduino.
603
+
**Arduino CMake** fully supports programmers for burning firmware and bootloader images directly onto the Arduino.
604
604
If you have a programmer that is supported by the *Arduino SDK*, everything should work out of the box.
605
605
As of version 1.0 of the *Arduino SDK*, the following programmers are supported:
0 commit comments