Skip to content
This repository was archived by the owner on Dec 23, 2021. It is now read-only.

Commit 240beef

Browse files
authored
README change (more stuff for microbit) part 2 (#274)
1 parent 918093c commit 240beef

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Device Simulator Express, a Microsoft Garage project
22

3-
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/Python-3.7%2B-blue.svg" alt="Python versions: 3.7+" /></a> <img src="https://img.shields.io/badge/VS%20Code-v1.43+-blue" alt="VS Code version 1.43"> <img src="https://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed." /> <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: We are using the MIT License"></a> <a href="CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-Welcome-brightgreen.svg" alt="We are welcoming PRS!"></a> <img src="https://img.shields.io/badge/platform-win%20%7C%20osx-lightgrey.svg" alt="Platforms Supported: Windows, MacOSX"/>
3+
<a href='https://www.python.org/downloads/'><img src='https://img.shields.io/badge/Python-3.7%2B-blue.svg' alt='Python versions: 3.7+' /></a> <img src='https://img.shields.io/badge/VS%20Code-v1.43+-blue' alt='VS Code version 1.43'> <img src='https://www.repostatus.org/badges/latest/active.svg' alt='Project Status: Active – The project has reached a stable, usable state and is being actively developed.' /> <a href='LICENSE'><img src='https://img.shields.io/badge/license-MIT-blue.svg' alt='License: We are using the MIT License'></a> <a href='CONTRIBUTING.md'><img src='https://img.shields.io/badge/PRs-Welcome-brightgreen.svg' alt='We are welcoming PRS!'></a> <img src='https://img.shields.io/badge/platform-win%20%7C%20osx-lightgrey.svg' alt='Platforms Supported: Windows, MacOSX'/>
44

5-
<a href="https://microsoftgarage.visualstudio.com/002806e2-ebaa-4672-9d2e-5fe5d29154ef/_boards/board/t/227906bb-31ac-4b07-8626-3d757754a616/Microsoft.RequirementCategory/"><img src="https://microsoftgarage.visualstudio.com/002806e2-ebaa-4672-9d2e-5fe5d29154ef/227906bb-31ac-4b07-8626-3d757754a616/_apis/work/boardbadge/73f82653-3da1-4a6f-bb79-c91c9eecec28" alt="Azure DevOps Board Badge" /></a>
5+
<a href='https://microsoftgarage.visualstudio.com/002806e2-ebaa-4672-9d2e-5fe5d29154ef/_boards/board/t/227906bb-31ac-4b07-8626-3d757754a616/Microsoft.RequirementCategory/'><img src='https://microsoftgarage.visualstudio.com/002806e2-ebaa-4672-9d2e-5fe5d29154ef/227906bb-31ac-4b07-8626-3d757754a616/_apis/work/boardbadge/73f82653-3da1-4a6f-bb79-c91c9eecec28' alt='Azure DevOps Board Badge' /></a>
66

77
Make without limit! Device Simulator Express, a Microsoft Garage project, allows you to code microcontrollers without the hardware on hand! You can program your Adafruit Circuit Playground Express (CPX) or your BBC micro:bit! Test and debug your code on the device simulator and see the same
88
result when you plug in your actual microcontroller. Curious about the output of the device, the serial
@@ -11,11 +11,11 @@ monitor allows you to observe the device output.
1111
## Devices we support:
1212
- [**Adafruit Circuit Playground Express (CPX)**](#adafruit-circuit-playground-express-cpx-simulator)
1313

14-
[<img alt='CircuitPlayground Express' src='assets/readmeFiles/cpx/cpx-img.png'>](#adafruit-circuit-playground-express-cpx-simulator)
14+
[<img alt='CircuitPlayground Express' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/cpx/cpx-img.png'>](#adafruit-circuit-playground-express-cpx-simulator)
1515

1616
- [**BBC micro:bit**](#bbc-microbit-simulator)
1717

18-
[<img alt='bbc micro:bit' src=assets/readmeFiles/microbit/microbit.png>](#bbc-microbit-simulator)
18+
[<img alt='bbc micro:bit' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/microbit/microbit.png'>](#bbc-microbit-simulator)
1919

2020

2121
## Build Status
@@ -84,14 +84,14 @@ To use Device Simulator Express, install the extension from the marketplace and
8484

8585
#### I. Take a look at the "Device Simulator Express: Getting Started" Command.
8686
1. Type in `"Device Simulator Express: [Circuit Playground Express] New File"` in the command palette (`CTRL + SHIFT + P` / `CMD + SHIFT + P` to open the command palette).
87-
<img alt="Deploy to Device" src='assets/readmeFiles/getting_started.png'>
88-
1. Choose the `CPX` option from the dropdown.
89-
2. Read, copy and learn some of the things you can do with the simulator!
87+
<img alt='Getting Started' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/getting_started.png'>
88+
2. Choose the `CPX` option from the dropdown.
89+
3. Read, copy and learn some of the things you can do with the simulator!
9090

9191
#### II. Start with the "Device Simulator Express [Circuit Playground Express]: New File" Command.
9292

9393
1. Type in `"Device Simulator Express: [Circuit Playground Express] New File"` in the command palette (`CTRL + SHIFT + P` / `CMD + SHIFT + P` to open the command palette).
94-
<img alt='"New File" animation' src='assets/readmeFiles/cpx/cpx-new-file.gif'>
94+
<img alt='"New CPX File" animation' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/cpx/cpx-new-file.gif'>
9595
2. Name and save your file somewhere, and we’re good to go!
9696
3. Start with some examples: you can find examples files and tutorials inside the comments, as well as in the notification pop up when you run the `"Device Simulator Express: [Circuit Playground Express] New File"` Command.
9797

@@ -102,7 +102,7 @@ To use Device Simulator Express, install the extension from the marketplace and
102102

103103
#### IV. Run your code on the simulator.
104104

105-
<img alt='How to run the simulator animation' src='assets/readmeFiles/cpx/cpx-run.gif'>
105+
<img alt='How to run the CPX simulator animation' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/cpx/cpx-run.gif'>
106106

107107
1. Run `Run Simulator` from the command palette or use the `Play` button on the simulator webview.
108108

@@ -113,7 +113,7 @@ Before deploying the Python code to your CPX device, you need to format your dev
113113
1. Download the firmware with the .uf2 file (link: https://learn.adafruit.com/adafruit-circuit-playground-express/circuitpython-quickstart).
114114
2. Download the lastest version of the cpx library (link: https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries).
115115

116-
<img alt="Deploy to Device" src='assets/readmeFiles/cpx/cpx-deploy.png'>
116+
<img alt='Deploy to CPX Device' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/cpx/cpx-deploy.png'>
117117

118118
#### VI. Use the Serial Monitor for your Adafruit CPX device (available on Windows and Mac only)
119119

@@ -184,14 +184,14 @@ In Device Simulator Express, you can use keyboard to interact with the device:
184184

185185
#### I. Take a look at the "Device Simulator Express: Getting Started" Command.
186186
1. Type in `"Device Simulator Express: [Circuit Playground Express] New File"` in the command palette (`CTRL + SHIFT + P` / `CMD + SHIFT + P` to open the command palette).
187-
<img alt="Deploy to Device" src='assets/readmeFiles/getting_started.png'>
187+
<img alt='Getting Started' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/getting_started.png'>
188188
2. Choose the `micro:bit` option from the dropdown.
189-
2. Read, copy and learn some of the things you can do with the simulator!
189+
3. Read, copy and learn some of the things you can do with the simulator!
190190

191191
#### II. Start with the "Device Simulator Express [micro:bit]: New File" Command.
192192

193193
1. Type in `"Device Simulator Express: [micro:bit] New File"` in the command palette (`CTRL + SHFT + P / CMD + SHIFT + P` to open the command palette).
194-
<img alt='"New File" animation' src='assets/readmeFiles/microbit/microbit-new-file.gif'>
194+
<img alt='"New micro:bit File" animation' src='https://github.com/microsoft/vscode-python-devicesimulator/blob/dev/assets/readmeFiles/microbit/microbit-new-file.gif'>
195195
2. Name and save your file somewhere, and we’re good to go!
196196

197197
#### III. Start from an existing Python file.
@@ -201,15 +201,15 @@ In Device Simulator Express, you can use keyboard to interact with the device:
201201

202202
#### IV. Run your code on the simulator.
203203

204-
<img alt='How to run the simulator animation' src='assets/readmeFiles/microbit/microbit-run.gif'>
204+
<img alt='How to run the micro:bit simulator animation' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/microbit/microbit-run.gif'>
205205

206206
1. Run `Run Simulator` from the command palette or use the `Play` button on the simulator webview.
207207

208208
#### V. Deploy your code to the physical device
209209

210210
1. Run `[micro:bit] Deploy to Device` from the command palette
211211

212-
<img alt="Deploy to Device" src="assets/readmeFiles/microbit/microbit-deploy.png">
212+
<img alt='Deploy to micro:bit device' src='https://github.com/microsoft/vscode-python-devicesimulator/blob/dev/assets/readmeFiles/microbit/microbit-deploy.png'>
213213

214214
#### VI. Use the Serial Monitor for your BBC micro:bit device (available on Windows and Mac only)
215215

0 commit comments

Comments
 (0)