Skip to content

Commit 83911e0

Browse files
authored
Merge pull request #1 from screamerbg/sam-taylor-arm-patch-1
Proof reading - SamT
2 parents 58f1959 + 73459fa commit 83911e0

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ This document covers the installation and usage of *mbed CLI*.
3434

3535
## Installation
3636

37-
*mbed CLI* was tested and runs equally well on Windows, Linux and Mac OSX. We're keen to learn about your experience with *mbed CLI* on other operating systems at the [mbed CLI development page](https://github.com/ARMmbed/mbed-cli).
37+
*mbed CLI* is supported on Windows, Linux and Mac OSX. We're keen to learn about your experience with *mbed CLI* on other operating systems at the [mbed CLI development page](https://github.com/ARMmbed/mbed-cli).
3838

3939
### Requirements
4040

4141
* **Python** - mbed CLI* is a Python script, so you'll need Python installed in order to use it. *mbed CLI* was tested with [version 2.7 of Python](https://www.python.org/download/releases/2.7/).
4242

43-
* **Git and Mercurial** - mbed CLI* supports both Git and Mercurial repositories, you'll need to install both:
43+
* **Git and Mercurial** - mbed CLI* supports both Git and Mercurial repositories, so you'll need to install both:
4444
* [Git](https://git-scm.com/).
4545
* [Mercurial](https://www.mercurial-scm.org/).
4646

@@ -76,7 +76,7 @@ To uninstall *mbed CLI*, simply run:
7676

7777
### Working context
7878

79-
Similar to Git, Mercurial and many other command-line tools, *mbed CLI* uses the current directory as a working context. Meaning that before calling any *mbed CLI* command, you should first change to a working directory of choice. For example:
79+
*mbed CLI* uses the current directory as a working context, in a similar way to Git, Mercurial and many other command-line tools. This means that before calling any *mbed CLI* command, you should first change to a working directory of choice. For example:
8080
```
8181
$ cd mbed-example-program
8282
$ cd mbed-os
@@ -148,8 +148,8 @@ You can create plain (empty) programs, without either mbed OS or mbed library b
148148
Use `mbed import` to clone an existing program and all its dependencies to your machine:
149149

150150
```
151-
$ mbed import https://github.com/ARMmbed/mbed-blinky-morpheus/
152-
$ cd mbed-blinky-morpheus
151+
$ mbed import https://github.com/ARMmbed/mbed-blinky/
152+
$ cd mbed-blinky
153153
```
154154

155155
*mbed CLI* also supports programs based on the mbed library, which are automatically detected and do not require additional options.
@@ -226,9 +226,9 @@ To update your program to another upstream version, go to the root folder of the
226226
$ mbed update [branch|tag|revison]
227227
```
228228

229-
This fetches new revisions from the remote repository, updates the program to the specified branch, tag or revision. If non of these is specified then it updates the latest revision in the current branch. These series of actions are performed recursively against all dependencies and sub-dependencies in the program tree.
229+
This fetches new revisions from the remote repository, updates the program to the specified branch, tag or revision. If none of these is specified then it updates the latest revision in the current branch. These series of actions are performed recursively against all dependencies and sub-dependencies in the program tree.
230230

231-
You can use change the working directory to a library folder and use `mbed update` to update that library and its dependencies to a different revision than the one referenced in the parent program or library. This allows you to experiment with different versions of libraries/dependencies in the program tree without having to change the parent program or library.
231+
You can change the working directory to a library folder and use `mbed update` to update that library and its dependencies to a different revision than the one referenced in the parent program or library. This allows you to experiment with different versions of libraries/dependencies in the program tree without having to change the parent program or library.
232232

233233
<span style="background-color:#E6E6E6;border:1px solid #000;display:block; height:100%; padding:10px">**Note**: This command will fail if there are changes in your program or library that will be overwritten as a result of running `update`. This is by design: *mbed CLI* does not run operations that would result in overwriting local changes that are not yet committed. If you get an error, take care of your local changes (commit or use one of the options below), then re-run `update`.</span>
234234

@@ -287,7 +287,7 @@ Use these with caution as your uncommitted changes and unpublished libraries can
287287

288288
#### Checking status
289289

290-
As you work on s code, you'll edit parts of it - either your own program code or code in some of the libraries that it depends on. You can get the status of all the repositories in your program (recursively) by running `mbed status`. If a repository has uncommitted changes, this command will display these changes. Example:
290+
As you develop your program, you'll edit parts of it - either your own code or code in some of the libraries that it depends on. You can get the status of all the repositories in your program (recursively) by running `mbed status`. If a repository has uncommitted changes, this command will display these changes. Example:
291291

292292
```
293293
[mbed] Status for "mbed-os-program":
@@ -503,7 +503,7 @@ A ``.uvproj`` file is created in the projectfiles/uvision folder. You can open t
503503

504504
### Testing
505505

506-
Use `mbed test --list-compile` to list the tests available:
506+
mbed OS comes with a comprehensive set of test tools (see blah.blah.com), and you can use *mbed CLI* to manage and execute tests for you. Use `mbed test --list-compile` to list the tests available:
507507

508508
```
509509
$ mbed test --list-compile

0 commit comments

Comments
 (0)