Update README.md #405
Update README.md #405
Conversation
Made Irit-approved grammar changes [mostly changing passive voice to active voice] and fixing hyphens
|
Under "Creating a new program for mbed OS 2," both links in the following sentence go to the same place: "mbed CLI is also compatible with mbed OS 2 programs based on the mbed library, and will automatically import the latest mbed library release if you use the --mbedlib option:" Should one of these links go somewhere else? |
|
|
||
| ### Requirements | ||
|
|
||
| * **Python** - mbed CLI is a Python script, so you'll need Python in order to use it. mbed CLI was tested with [version 2.7.11 of Python](https://www.python.org/downloads/release/python-2711/) and is not compatible with Python 3. | ||
| * **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. |
There was a problem hiding this comment.
We tested and we also currently test with Python 2.7.x, past and present tense. I don't mind which tense we use, just thought I'd point out we're also continuing to test it :)
| * **Command-line compiler or IDE Toolchain** - mbed CLI invokes the [mbed OS 5](https://github.com/ARMmbed/mbed-os) tools for various features, like compiling, testing and exporting to industry standard toolchains. To compile your code, you will need either of these: | ||
| * Compilers: GCC ARM, ARM Compiler 5, IAR | ||
| * Toolchains: Keil uVision, DS-5, IAR Workbench | ||
| * **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: |
There was a problem hiding this comment.
You don't need both the compiler and a toolchain, you need either a compiler or a toolchain.
In all honesty, we use the terms compiler and toolchain slightly interchangeably. I would personally recommend changing the word toolchain to IDE. If this requires changes through the rest of the document to keep this consistent, then that can come in a separate PR.
| @@ -763,27 +763,27 @@ Run `mbed update <tag_name|revision> --clean` | |||
|
|
|||
| __When you have unpublished local libraries__ | |||
|
|
|||
| There are three additional options that define how unpublished local libraries are handled: | |||
| There are three additional options that show how unpublished local libraries are handled: | |||
There was a problem hiding this comment.
Might just be me but when I see show coupled with an option description, I assume it's going to print something to screen. When really these options modify the behavior of the tool. Perhaps we can say modify instead of define or show?
Addressed Brian's comments and fixed some additional commas
|
Changes look good to me! Care to take a look @screamerbg? |
|
Thanks! |
Made Irit-approved grammar changes [mostly changing passive voice to active voice and fixing hyphens]