Skip to content

Commit 9b4a3e6

Browse files
author
AnotherButler
authored
Update README.md
Addressed Brian's comments and fixed some additional commas
1 parent 5e06b54 commit 9b4a3e6

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
@@ -1,6 +1,6 @@
11
## Introduction
22

3-
*mbed CLI* is the name of the ARM mbed command-line tool, packaged as mbed-cli, which enables the full mbed workflow: repositories version control, maintaining dependencies, publishing code, updating from remotely hosted repositories (GitHub, GitLab and mbed.org), and invoking ARM mbed's own build system and export functions, among other operations.
3+
*mbed CLI* is the name of the ARM mbed command-line tool, packaged as mbed-cli, which enables the full mbed workflow: repositories version control, maintaining dependencies, publishing code, updating from remotely hosted repositories (GitHub, GitLab and mbed.org) and invoking ARM mbed's own build system and export functions, among other operations.
44

55
This document covers the installation and usage of mbed CLI.
66

@@ -54,17 +54,17 @@ Windows, Linux and Mac OS X support mbed CLI. We're keen to learn about your exp
5454

5555
### Requirements
5656

57-
* **Python** - mbed CLI is a Python script, so you'll need Python to use it. We tested mbed CLI with [version 2.7.11 of Python](https://www.python.org/downloads/release/python-2711/). It is not compatible with Python 3.
57+
* **Python** - mbed CLI is a Python script, so you'll need Python to use it. We test mbed CLI with [version 2.7.11 of Python](https://www.python.org/downloads/release/python-2711/). It is not compatible with Python 3.
5858

5959
* **Git and Mercurial** - mbed CLI supports both Git and Mercurial repositories, so you'll need to install both:
6060
* [Git](https://git-scm.com/) - version 1.9.5 or later.
6161
* [Mercurial](https://www.mercurial-scm.org/) - version 2.2.2 or later.
6262

6363
<span class="tips">**Note:** The directories of Git and Mercurial executables (`git` and `hg`) need to be in your system's PATH.</span>
6464

65-
* **Command-line compiler or IDE toolchain** - mbed CLI invokes the [mbed OS 5](https://github.com/ARMmbed/mbed-os) tools for various features, such as compiling, testing and exporting to industry standard toolchains. To compile your code, you will need a compiler and a toolchain:
65+
* **Command-line compiler or IDE toolchain** - mbed CLI invokes the [mbed OS 5](https://github.com/ARMmbed/mbed-os) tools for various features, such as compiling, testing and exporting to industry standard toolchains. To compile your code, you will need either a compiler or an IDE:
6666
* Compilers: GCC ARM, ARM Compiler 5, IAR.
67-
* Toolchains: Keil uVision, DS-5, IAR Workbench.
67+
* IDE: Keil uVision, DS-5, IAR Workbench.
6868

6969

7070
### Video tutorial for manual installation
@@ -693,7 +693,7 @@ $ git remote set-url --push origin https://github.com/screamerbg/repo-fork
693693

694694
Each time you `git` commit and push, or use `mbed publish`, the new revisions will be pushed against your fork. You can fetch from the original repository using `mbed update` or `git pull`. If you explicitly want to fetch or pull from your fork, then you can use `git pull https://github.com/screamerbg/repo-fork [branch]`.
695695

696-
Through the workflow explained above, mbed CLI will maintain association to the original repository (which you may want to send a pull request to), and will record references with the revision hashes that you push to your fork. Until your pull request (PR) is accepted, all recorded references will be invalid. Once the PR is accepted, all revision hashes from your fork will become part the original repository, so all references will become valid.
696+
Through the workflow explained above, mbed CLI will maintain association to the original repository (which you may want to send a pull request to) and will record references with the revision hashes that you push to your fork. Until your pull request (PR) is accepted, all recorded references will be invalid. Once the PR is accepted, all revision hashes from your fork will become part the original repository, so all references will become valid.
697697

698698
## Updating programs and libraries
699699

@@ -747,7 +747,7 @@ __I want a clean update (and discard uncommitted changes)__
747747

748748
Run `mbed update [branch] --clean`
749749

750-
Specifying a branch to `mbed update` will only check out that branch, and won't automatically merge or fast-forward to the remote/upstream branch. You can run `mbed update` to merge (fast-forward) your local branch with the latest remote branch. On Git you can do `git pull`.
750+
Specifying a branch to `mbed update` will only check out that branch and won't automatically merge or fast-forward to the remote/upstream branch. You can run `mbed update` to merge (fast-forward) your local branch with the latest remote branch. On Git you can do `git pull`.
751751

752752
<span class="warnings">**Warning**: The `--clean` option tells mbed CLI to update that program or library and its dependencies and discard all local changes. This action cannot be undone; use with caution.</span>
753753

@@ -763,13 +763,13 @@ Run `mbed update <tag_name|revision> --clean`
763763

764764
__When you have unpublished local libraries__
765765

766-
There are three additional options that show how unpublished local libraries are handled:
766+
There are three additional options that modify how unpublished local libraries are handled:
767767

768-
* `mbed update --clean-deps` - update the current program or library and its dependencies, and discard all local unpublished repositories. Use this with caution because your local unpublished repositories cannot be restored unless you have a backup copy.
768+
* `mbed update --clean-deps` - update the current program or library and its dependencies and discard all local unpublished repositories. Use this with caution because your local unpublished repositories cannot be restored unless you have a backup copy.
769769

770770
* `mbed update --clean-files` - update the current program or library and its dependencies, discard local uncommitted changes and remove any untracked or ignored files. Use this with caution because your local unpublished repositories cannot be restored unless you have a backup copy.
771771

772-
* `mbed update --ignore` - update the current program or library and its dependencies, and ignore any local unpublished libraries (they won't be deleted or modified, just ignored).
772+
* `mbed update --ignore` - update the current program or library and its dependencies and ignore any local unpublished libraries (they won't be deleted or modified, just ignored).
773773

774774
__Combining update options__
775775

0 commit comments

Comments
 (0)