Fixed major grammatical issues & formatting issues (#681)

ajitzero · czgtest · commit 5c5a7e2c051c · 2018-11-09T13:06:47.000+08:00
- [x] Fixed several grammatical issues
    - [x] Options
    - [x] Debugging Arduino Code preview
    - [x] Supported Operating Systems
    - [x] Support
- [x] Fixed formatting issues in:
    - [x] Prerequisites
    - [x] Options
    - [x] Development
- [x] Added keyboard shortcut HTML throughout the file
diff --git a/README.md b/README.md
@@ -12,30 +12,29 @@ Welcome to Visual Studio Code extension for **Arduino** <sup>preview</sup> ! The
 * Built-in serial monitor
 * Snippets for sketches
 * Automatic Arduino project scaffolding
-* Command Palette (`F1`) integration of frequently used commands (e.g. Verify, Upload...)
+* Command Palette (<kbd>F1</kbd>) integration of frequently used commands (e.g. Verify, Upload...)
 * Integrated Arduino Debugging <sup>New</sup>
 
 ## Prerequisites
 Arduino IDE is required. Please install it from [here](https://www.arduino.cc/en/main/software#download).
-- `Note: Arduino IDE 1.8.7 has some breaking changes, it will install board package and library failed, So it is recommended that you install version 1.8.6`
-- The supported Arduino IDE versions are 1.6.x and later.
+- *Note:* Arduino IDE `1.8.7` has some breaking changes, as it will install board package and library fails. It is recommended that you install version `1.8.6`
+- The supported Arduino IDE versions are `1.6.x` and later.
 - The Windows Store's version of Arduino IDE is not supported because of the sandbox environment of Windows app.
 
 ## Installation
-Open VS Code and press `F1` or `Ctrl + Shift + P` to open command palette, select **Install Extension** and type `vscode-arduino`.
+Open VS Code and press <kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> to open command palette, select **Install Extension** and type `vscode-arduino`.
 
-Or launch VS Code Quick Open (`Ctrl + P`), paste the following command, and press enter.
+Or launch VS Code Quick Open (<kbd>Ctrl</kbd> + <kbd>P</kbd>), paste the following command, and press enter.
 ```bash
 ext install vscode-arduino
 ```
 You can also install directly from Marketplace within Visual Studio Code, searching `Arduino`.
 
 ## Get Started
-You can find code samples and tutorials each time you connect a supported device.
-Alternatively you can visit our [IoT Developer Blog Space](https://aka.ms/iotdevblog) or [Get Started Tutorials](https://docs.microsoft.com/azure/iot-hub/iot-hub-arduino-iot-devkit-az3166-get-started).
+You can find code samples and tutorials each time you connect a supported device. Alternatively you can visit our [IoT Developer Blog Space](https://aka.ms/iotdevblog) or [Get Started Tutorials](https://docs.microsoft.com/azure/iot-hub/iot-hub-arduino-iot-devkit-az3166-get-started).
 
 ## Commands
-This extension provides several commands in the Command Palette (`F1` or `Ctrl + Shift + P`) for working with `*.ino` files:
+This extension provides several commands in the Command Palette (<kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) for working with `*.ino` files:
 
 - **Arduino: Board Manager**: Manage packages for boards. You can add 3rd party Arduino board by configuring `Additional Board Manager URLs` in board manager.
 - **Arduino: Change Baud Rate**: Change the baud rate of selected serial port.
@@ -52,7 +51,7 @@ This extension provides several commands in the Command Palette (`F1` or `Ctrl +
 - **Arduino: Verify**: Build sketch.
 
 ## Options
-The following Visual Studio Code settings are available for the Arduino extension. These can be set in global user preferences `Ctrl + ,` or workspace settings (.vscode/settings.json). The later overrides the former.
+The following Visual Studio Code settings are available for the Arduino extension. These can be set in global user preferences <kbd>Ctrl</kbd> + <kbd>,</kbd> or workspace settings (`.vscode/settings.json`). The later overrides the former.
 
 ```json
 {
@@ -70,20 +69,22 @@ The following Visual Studio Code settings are available for the Arduino extensio
 }
 ```
 - `arduino.path` - Path to Arduino, you can use a custom version of Arduino by modifying this setting to include the full path. Example: `C:\\Program Files\\Arduino` for Windows, `/Applications` for Mac, `/home/<username>/Downloads/arduino-1.8.1` for Linux. (Requires a restart after change). The default value is automatically detected from your Arduino IDE installation path.
-- `arduino.commandPath` - Path to an executable (or script) relative to `arduino.path`.The default value is `arduino_debug.exe`for windows,`arduino`for ubuntu; You also can use a custom launch script to run Arduino by modifying this setting. (Requires a restart after change) Example: `run-arduino.bat` for Windows, `Contents/MacOS/run-arduino.sh` for Mac, `bin/run-arduino.sh` for Linux."
-- `arduino.additionalUrls` - Additional Boards Manager Urls for 3rd party packages. You can have multiple URLs in one string with comma(,) as separator, or have a string array. The default value is empty.
+- `arduino.commandPath` - Path to an executable (or script) relative to `arduino.path`. The default value is `arduino_debug.exe`for windows and `arduino`for ubuntu. You also can use a custom launch script to run Arduino by modifying this setting. (Requires a restart after change) Example: `run-arduino.bat` for Windows, `Contents/MacOS/run-arduino.sh` for Mac, `bin/run-arduino.sh` for Linux.
+- `arduino.additionalUrls` - Additional Boards Manager URLs for 3rd party packages. You can have multiple URLs in one string with comma(`,`) as separator, or have a string array. The default value is empty.
 - `arduino.logLevel` - CLI output log level. Could be info or verbose. The default value is `"info"`.
-- `arduino.enableUSBDetection` - Enable/disable USB detection from the VSCode Arduino extension. The default value is `true`. when plug in your device to your computer, will pop up a message "Detected board ****, Would you like to switch to this board type", after click "yes" button, will automatically detect on which serial port (COM) is connected an usb device. if your device does not support this feature, please provide us with the pid/vid of device, the code format is defined in misc/usbmapping.json. 
+- `arduino.enableUSBDetection` - Enable/disable USB detection from the VSCode Arduino extension. The default value is `true`. When your device is plugged in to your computer, it will pop up a message "`Detected board ****, Would you like to switch to this board type`". After clicking the `Yes` button, it will automatically detect which serial port (COM) is connected a USB device. If your device does not support this feature, please provide us with the PID/VID of your device; the code format is defined in `misc/usbmapping.json`.
 > To learn more about how to list the vid/pid, use this tools https://github.com/EmergingTechnologyAdvisors/node-serialport
+
 ```bash
 npm install -g serialport
 serialport-list -f jsonline
 ```
-- `arduino.disableTestingOpen` - Disable/enable auto sending a test message to serial port for checking open status. The default value is `false` (a test message will be sent).
+
+- `arduino.disableTestingOpen` - Enable/disable automatically sending a test message to serial port for checking open status. The default value is `false` (a test message will be sent).
 - `arduino.skipHeaderProvider` - Enable/disable the extension providing completion items for headers. The functionality is included in newer versions of the C++ extension. The default value is `false`.
 - `arduino.defaultBaudRate` - Default baud rate for serial port monitor. The default value is 115200. Supported values are 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230400 and 250000.
 
-The following settings are per sketch settings of the Arduino extension. You can find them in
+The following settings are as per sketch settings of the Arduino extension. You can find them in
 `.vscode/arduino.json` under the workspace.
 
 ```json
@@ -99,12 +100,12 @@ The following settings are per sketch settings of the Arduino extension. You can
 - `sketch` - The main sketch file name of Arduino.
 - `port` - Name of the serial port connected to the device. Can be set by the `Arduino: Select Serial Port` command.
 - `board` - Current selected Arduino board alias. Can be set by the `Arduino: Change Board Type` command. Also, you can find the board list there.
-- `output` - Arduino build output path. If not set, Arduino will create a new temporary output folder each time, which means it cannot reuse the intermediate result of the previous build, leading to long verify/upload time. So it is recommended to set the field. Arduino requires that the output path should not be the workspace itself or subfolder of the workspace, otherwise, it may not work correctly. By default, this option is not set.
+- `output` - Arduino build output path. If not set, Arduino will create a new temporary output folder each time, which means it cannot reuse the intermediate result of the previous build leading to long verify/upload time, so it is recommended to set the field. Arduino requires that the output path should not be the workspace itself or subfolder of the workspace, otherwise, it may not work correctly. By default, this option is not set.
 - `debugger` - The short name of the debugger that will be used when the board itself does not have any debugger and there are more than one debugger available. You can find the list of debuggers [here](https://github.com/Microsoft/vscode-arduino/blob/master/misc/debuggerUsbMapping.json). By default, this option is not set.
-- `prebuild` - External command before build sketch file. You should only set one prebuild command. `command1 && command2` doesn't work. If you need run multiple commands before build, write them into a script.
+- `prebuild` - External command before build sketch file. You should only set one prebuild command. `command1 && command2` doesn't work. If you need to run multiple commands before build, write them into a script.
 
 ## Debugging Arduino Code <sup>preview</sup>
-Before you start debug your Arduino code, read [this doc](https://code.visualstudio.com/docs/editor/debugging) and get to know the basic mechanism about debugging in Visual Studio Code. Also see [debugging for C++ in VSCode](https://code.visualstudio.com/docs/languages/cpp#_debugging) for your reference.
+Before you start debugging your Arduino code, read [this doc](https://code.visualstudio.com/docs/editor/debugging) and get to know the basic mechanism about debugging in Visual Studio Code. Also, see [debugging for C++ in VSCode](https://code.visualstudio.com/docs/languages/cpp#_debugging) for your reference.
 
 Make sure your Arduino board can work with [STLink](http://www.st.com/en/development-tools/st-link-v2.html), [Jlink](https://www.segger.com/jlink-debug-probes.html) or [EDBG](http://www.atmel.com/webdoc/protocoldocs/ch01s01.html). The debugging support currently is fully tested with the following boards.
 - [MXChip IoT Developer Kit - AZ3166](https://microsoft.github.io/azure-iot-developer-kit/)
@@ -114,26 +115,26 @@ Make sure your Arduino board can work with [STLink](http://www.st.com/en/develop
 - Arduino Zero Pro
 
 Steps to start debugging:
-1. Plugin your board to your development machine properly. For those boards don't have on-board debugging chip, you need use STLink or JLink connector.
-2. Go to **Debug View** (`Ctrl + Shift + D`). Set breakpoints in your source files.
-3. Press `F5` to select debugging environment.
-4. When your breakpoint is hit, you can see variables and add expression to watch on the Debug Side Bar.
+1. Plug in your board to your development machine properly. For those boards which don't have an on-board debugging chip, you need to use a STLink or JLink connector.
+2. Go to **Debug View** (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd>). Set breakpoints in your source files.
+3. Press <kbd>F5</kbd> to select your debugging environment.
+4. When your breakpoint is hit, you can see variables and add expression(s) to watch on the Debug Side Bar.
 
 > To learn more about how to debug Arduino code, visit our [team blog](https://blogs.msdn.microsoft.com/iotdev/2017/05/27/debug-your-arduino-code-with-visual-studio-code/).
 
 ## Change Log
 See the [Change log](https://github.com/Microsoft/vscode-arduino/blob/master/CHANGELOG.md) for the details of changes for each version.
 
 ## Supported Operating Systems
-Currently this extension supports the following operatings systems:
+Currently this extension supports the following operating systems:
 
 - Windows 7 and later (32-bit and 64-bit)
 - macOS 10.10 and later
 - Ubuntu 16.04
-  - The extension might work on other Linux distro as some user reported but without gurantee.
+  - The extension might work on other Linux distros, as reported by some users but that is without guarantee.
 
 ## Support
-You can find the full list of issues at [Issue Tracker](https://github.com/Microsoft/vscode-arduino/issues). You can submit a [bug or feature suggestion](https://github.com/Microsoft/vscode-arduino/issues/new), and participate community driven [discussions](https://gitter.im/Microsoft/vscode-arduino).
+You can find the full list of issues at [Issue Tracker](https://github.com/Microsoft/vscode-arduino/issues). You can submit a [bug or feature suggestion](https://github.com/Microsoft/vscode-arduino/issues/new), and participate in community driven [discussions](https://gitter.im/Microsoft/vscode-arduino).
 
 ## Development
 
@@ -149,9 +150,9 @@ To *run and develop*, do the following:
 - Run `npm i`
 - Run `npm i -g gulp`
 - Open in Visual Studio Code (`code .`)
-- Press `F5` to debug
+- Press <kbd>F5</kbd> to debug.
 
-To *test do the following*: `F5` in VS Code with the "Launch Tests" debug configuration.
+*To test do the following:* <kbd>F5</kbd> in VS Code with the "Launch Tests" debug configuration.
 
 ## Code of Conduct
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct). For more information please see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/#howadopt) or contact opencode@microsoft.com with any additional questions or comments.
