Skip to content

Commit 3f77bd4

Browse files
Merge pull request queezythegreat#89 from gusennan/master
improved grammar in README.rst
2 parents da5f71a + 6001d8d commit 3f77bd4

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Arduino is a great development platform, which is easy to use. It has everything
66

77
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.
88

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.
1010

1111
The **Arduino CMake** build system integrates tightly with the *Arduino SDK*.
1212

1313
*Arduino SDK* version **0.19** or higher is required.
1414

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.
1616

1717
Features
1818
--------
@@ -35,7 +35,7 @@ Features
3535
Feedback
3636
--------
3737

38-
**Arduino CMake** is hosted on GitHUB and is available at:
38+
**Arduino CMake** is hosted on GitHub and is available at:
3939

4040
https://github.com/queezythegreat/arduino-cmake
4141

@@ -44,7 +44,7 @@ Did you find a bug or would like a specific feature, please report it at:
4444
https://github.com/queezythegreat/arduino-cmake/issues
4545

4646
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``.
4848

4949

5050
Requirements
@@ -191,16 +191,16 @@ For a more detailed explanation, please read on...
191191

192192
2. Creating a build directory
193193

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.
195195

196-
So lets create that build directory::
196+
So let's create that build directory::
197197

198198
mkdir build
199199
cd build
200200

201201
3. Creating the build system
202202

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::
204204

205205
cmake ..
206206

@@ -427,7 +427,7 @@ You can specify the options in two ways, either as the command arguments or as v
427427

428428
Where **${TARGET_NAME}** is the name of you target and **${OPTION_NAME}** is the name of the option.
429429

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*::
431431

432432
set(blink_lib_SRCS blink_lib.cpp)
433433
set(blink_lib_HDRS blink_lib.h)
@@ -442,7 +442,7 @@ The other way of defining the same thing is::
442442
HDRS blink_lib.h
443443
BOARD uno)
444444

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::
446446

447447
set(blink_SRCS blink.cpp)
448448
set(blink_HDRS blink.h)
@@ -485,7 +485,7 @@ Any source files contained within that directory is part of the library. Here is
485485
|-- ExampleLib.cpp
486486
`-- OtherLibSource.cpp
487487

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, 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.
489489

490490
To incorporate a library into your firmware, you can do one of three things:
491491

@@ -600,7 +600,7 @@ or when configuring the project::
600600
Programmers
601601
~~~~~~~~~~~
602602

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.
604604
If you have a programmer that is supported by the *Arduino SDK*, everything should work out of the box.
605605
As of version 1.0 of the *Arduino SDK*, the following programmers are supported:
606606

0 commit comments

Comments
 (0)