diff --git a/README.md b/README.md index 6c466799..990e6323 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ Welcome to Visual Studio Code extension for **Arduino** preview ! The * Built-in serial monitor * Snippets for sketches * Automatic Arduino project scaffolding -* Command Palette (F1) integration of frequently used commands (e.g. Verify, Upload...) -* Integrated Arduino Debugging New +* Command Palette (`F1`) integration of frequently used commands (e.g. Verify, Upload...) +* Integrated Arduino Debugging New ## Prerequisites Arduino IDE is required. Please install it from [here](https://www.arduino.cc/en/main/software#download). @@ -27,21 +27,21 @@ Or launch VS Code Quick Open (`Ctrl + P`), paste the following command, and pres ```bash ext install vscode-arduino ``` -You can also install directly from Marketplace within Visual Studio Code, searching `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://aka.ms/azureiotgetstarted) +Alternatively you can visit our [IoT Developer Blog Space](https://aka.ms/iotdevblog) or [Get Started Tutorials](https://aka.ms/azureiotgetstarted). ## 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 (`F1` or `Ctrl + Shift + P`) 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. - **Arduino: Change Board Type**: Change board type or platform. - **Arduino: Close Serial Monitor**: Stop serial monitor and release the serial port. - **Arduino: Examples**: Show example list. -- **Arduino: Initialize**:Scaffold a VS Code project with an Arduino sketch. +- **Arduino: Initialize**: Scaffold a VS Code project with an Arduino sketch. - **Arduino: Library Manager**: Explore and manage libraries. - **Arduino: Open Serial Monitor**: Open serial monitor in the intergrated output window. - **Arduino: Select Serial Port**: Change the current serial port. @@ -75,8 +75,8 @@ Make sure your Arduino board can work with [STLink](http://www.st.com/en/develop 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. +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. > 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/). @@ -93,7 +93,7 @@ Currently this extension supports the following operatings systems: - The extension might work on other Linux distro as some user reported but without gurantee. ## 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 community driven [discussions](https://gitter.im/Microsoft/vscode-arduino). ## Development @@ -109,9 +109,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 `F5` to debug -To *test do the following*: **F5** in VS Code with the "Launch Tests" debug configuration. +To *test do the following*: `F5` 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.