Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit d52dd49

Browse files
authored
Merge pull request #361 from eduherminio/master
Update README.md
2 parents 65ed13a + 72d106a commit d52dd49

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Welcome to Visual Studio Code extension for **Arduino** <sup>preview</sup> ! The
1212
* Built-in serial monitor
1313
* Snippets for sketches
1414
* Automatic Arduino project scaffolding
15-
* Command Palette (F1) integration of frequently used commands (e.g. Verify, Upload...)
16-
* Integrated Arduino Debugging <sup>New</sup>
15+
* Command Palette (`F1`) integration of frequently used commands (e.g. Verify, Upload...)
16+
* Integrated Arduino Debugging <sup>New</sup>
1717

1818
## Prerequisites
1919
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
2727
```bash
2828
ext install vscode-arduino
2929
```
30-
You can also install directly from Marketplace within Visual Studio Code, searching `Arduino`
30+
You can also install directly from Marketplace within Visual Studio Code, searching `Arduino`.
3131

3232
## Get Started
3333
You can find code samples and tutorials each time you connect a supported device.
34-
Alternatively you can visit our [IoT Developer Blog Space](https://aka.ms/iotdevblog) or [Get Started Tutorials](https://aka.ms/azureiotgetstarted)
34+
Alternatively you can visit our [IoT Developer Blog Space](https://aka.ms/iotdevblog) or [Get Started Tutorials](https://aka.ms/azureiotgetstarted).
3535

3636
## Commands
37-
This extension provides several commands in the Command Palette (**F1** or **Ctrl+Shift+P**) for working with `*.ino` files:
37+
This extension provides several commands in the Command Palette (`F1` or `Ctrl + Shift + P`) for working with `*.ino` files:
3838

3939
- **Arduino: Board Manager**: Manage packages for boards. You can add 3rd party Arduino board by configuring `Additional Board Manager URLs` in board manager.
4040
- **Arduino: Change Baud Rate**: Change the baud rate of selected serial port.
4141
- **Arduino: Change Board Type**: Change board type or platform.
4242
- **Arduino: Close Serial Monitor**: Stop serial monitor and release the serial port.
4343
- **Arduino: Examples**: Show example list.
44-
- **Arduino: Initialize**Scaffold a VS Code project with an Arduino sketch.
44+
- **Arduino: Initialize**: Scaffold a VS Code project with an Arduino sketch.
4545
- **Arduino: Library Manager**: Explore and manage libraries.
4646
- **Arduino: Open Serial Monitor**: Open serial monitor in the intergrated output window.
4747
- **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
7575

7676
Steps to start debugging:
7777
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.
78-
2. Go to **Debug View** (Ctrl+Shift+D). Set breakpoints in your source files.
79-
3. Press **F5** to select debugging environment.
78+
2. Go to **Debug View** (`Ctrl + Shift + D`). Set breakpoints in your source files.
79+
3. Press `F5` to select debugging environment.
8080
4. When your breakpoint is hit, you can see variables and add expression to watch on the Debug Side Bar.
8181

8282
> 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:
9393
- The extension might work on other Linux distro as some user reported but without gurantee.
9494

9595
## Support
96-
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)
96+
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).
9797

9898
## Development
9999

@@ -109,9 +109,9 @@ To *run and develop*, do the following:
109109
- Run `npm i`
110110
- Run `npm i -g gulp`
111111
- Open in Visual Studio Code (`code .`)
112-
- Press **F5** to debug
112+
- Press `F5` to debug
113113

114-
To *test do the following*: **F5** in VS Code with the "Launch Tests" debug configuration.
114+
To *test do the following*: `F5` in VS Code with the "Launch Tests" debug configuration.
115115

116116
## Code of Conduct
117117
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 [email protected] with any additional questions or comments.

0 commit comments

Comments
 (0)