diff --git a/README.md b/README.md index 91b1a810d..4a74ba96a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Device Simulator Express, a Microsoft Garage project -Python versions: 3.7+ VS Code version 1.43 Project Status: Active – The project has reached a stable, usable state and is being actively developed. License: We are using the MIT License We are welcoming PRS! Platforms Supported: Windows, MacOSX +Python versions: 3.7+ VS Code version 1.43 Project Status: Active – The project has reached a stable, usable state and is being actively developed. License: We are using the MIT License We are welcoming PRS! Platforms Supported: Windows, MacOSX -Azure DevOps Board Badge +Azure DevOps Board Badge 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 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. ## Devices we support: - [**Adafruit Circuit Playground Express (CPX)**](#adafruit-circuit-playground-express-cpx-simulator) - [CircuitPlayground Express](#adafruit-circuit-playground-express-cpx-simulator) + [CircuitPlayground Express](#adafruit-circuit-playground-express-cpx-simulator) - [**BBC micro:bit**](#bbc-microbit-simulator) - [bbc micro:bit](#bbc-microbit-simulator) + [bbc micro:bit](#bbc-microbit-simulator) ## Build Status @@ -84,14 +84,14 @@ To use Device Simulator Express, install the extension from the marketplace and #### I. Take a look at the "Device Simulator Express: Getting Started" Command. 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). -Deploy to Device -1. Choose the `CPX` option from the dropdown. -2. Read, copy and learn some of the things you can do with the simulator! +Getting Started +2. Choose the `CPX` option from the dropdown. +3. Read, copy and learn some of the things you can do with the simulator! #### II. Start with the "Device Simulator Express [Circuit Playground Express]: New File" Command. 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). - "New File" animation + "New CPX File" animation 2. Name and save your file somewhere, and we’re good to go! 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. @@ -102,7 +102,7 @@ To use Device Simulator Express, install the extension from the marketplace and #### IV. Run your code on the simulator. -How to run the simulator animation +How to run the CPX simulator animation 1. Run `Run Simulator` from the command palette or use the `Play` button on the simulator webview. @@ -113,7 +113,7 @@ Before deploying the Python code to your CPX device, you need to format your dev 1. Download the firmware with the .uf2 file (link: https://learn.adafruit.com/adafruit-circuit-playground-express/circuitpython-quickstart). 2. Download the lastest version of the cpx library (link: https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries). -Deploy to Device +Deploy to CPX Device #### VI. Use the Serial Monitor for your Adafruit CPX device (available on Windows and Mac only) @@ -184,14 +184,14 @@ In Device Simulator Express, you can use keyboard to interact with the device: #### I. Take a look at the "Device Simulator Express: Getting Started" Command. 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). -Deploy to Device +Getting Started 2. Choose the `micro:bit` option from the dropdown. -2. Read, copy and learn some of the things you can do with the simulator! +3. Read, copy and learn some of the things you can do with the simulator! #### II. Start with the "Device Simulator Express [micro:bit]: New File" Command. 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). - "New File" animation + "New micro:bit File" animation 2. Name and save your file somewhere, and we’re good to go! #### III. Start from an existing Python file. @@ -201,7 +201,7 @@ In Device Simulator Express, you can use keyboard to interact with the device: #### IV. Run your code on the simulator. -How to run the simulator animation +How to run the micro:bit simulator animation 1. Run `Run Simulator` from the command palette or use the `Play` button on the simulator webview. @@ -209,7 +209,7 @@ In Device Simulator Express, you can use keyboard to interact with the device: 1. Run `[micro:bit] Deploy to Device` from the command palette -Deploy to Device +Deploy to micro:bit device #### VI. Use the Serial Monitor for your BBC micro:bit device (available on Windows and Mac only)