Readme Update and adding MD File for Store Upload

README.md

@@ -4,8 +4,7 @@
 
 <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>
 
-Make without limit! Device Simulator Express, a Microsoft Garage project, allows you to code in CircuitPython for your awesome
-Circuit Playground Express (CPX) projects! Test and debug your code on the device simulator and see the same
+Make without limit! Device Simulator Express, a Microsoft Garage project, allows you to code microcontrollers without the hardware on hand! You can program your 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
 monitor allows you to observe the device output.
 
@@ -20,9 +19,21 @@ monitor allows you to observe the device output.
 | master  | [![Build Status](https://microsoftgarage.visualstudio.com/Intern%20GitHub/_apis/build/status/Adafruit/Pacifica-CI?branchName=master)](https://microsoftgarage.visualstudio.com/Intern%20GitHub/_build/latest?definitionId=304&branchName=master) |
 
 
-## Features
+## Prerequisites
+
+The following dependencies are required to install before launching Device Simulator Express.  
+You will be prompted to install the Python dependencies during the first use.
+
+- _**[Visual Studio Code](https://code.visualstudio.com/)**_
+- _**[Node](https://nodejs.org/en/download/)**_
+- _**[Python 3.7+](https://www.python.org/downloads/)**_: Make sure you've added python and pip to your PATH in your environment variables. (1)
+- _**[Python VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)**_: This will be installed automatically from the marketplace when you install Device Simulator Express.
+
+## Circuit Playground Express (CPX) Simulator
 
-- IntelliSense and syntax highlighting for CircuitPython code (only supports CPX Express library)
+### Features
+
+- IntelliSense and syntax highlighting for CircuitPython code
 - Template file generation
 - Integrated Python Debugging for the Simulator
 - Serial monitor (available on Windows and Mac only)
@@ -46,27 +57,10 @@ The simulator supports most of the sensors on CPX except **IR transmitter & Rece
 The code related to these sensors can still run on the actual CPX board and be deployed using Device Simulator Express.  
 As we only support CPX library now, other libraries (i.e. simpleio) can’t run on the simulator. But they will work on the actual device!
 
-## Prerequisites
-
-The following dependencies are required to install before launching Device Simulator Express.  
-You will be prompted to install the Python dependencies during the first use.
-
-- _**[Visual Studio Code](https://code.visualstudio.com/)**_
-- _**[Node](https://nodejs.org/en/download/)**_
-- _**[Python 3.7.4](https://www.python.org/downloads/)**_: Make sure you've added python and pip to your PATH in your environment variables. (1)
-- _**[Python VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)**_: This will be installed automatically from the marketplace when you install Device Simulator Express.
 
-- Python Modules for Simulation
-  - **Note:** On extension activation, you will be prompted with a popup message asking if you want the modules to be automatically installed for you. The following Python modules should be downloaded when you select "yes" on the prompt message. **If modules are not installed correctly, please use the "pip install" commands listed below.**
-    - Playsound : `pip install playsound`
-    - Pywin32 : `pip install pywin32`
-      - On Windows, you need to use the above command in the console to manually install pywin32.
-    - Python-Socketio : `pip install python-socketio`
-    - Requests : `pip install requests`
-    - Application Insights: `pip install applicationinsights`
 
 
-## Useful Links
+### Useful Links
 - Tutorials and Example Code for Adafruit CPX:
   - [Adafruit CPX library tutorial](https://learn.adafruit.com/circuitpython-made-easy-on-circuit-playground-express/circuit-playground-express-library)
   - [Adafruit CPX Examples on GitHub](https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/tree/master/examples)
@@ -75,35 +69,33 @@ You will be prompted to install the Python dependencies during the first use.
   - [Tutorial for formatting Adafruit CPX for CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython)
   - [Download Firmware .uf2 file](https://learn.adafruit.com/adafruit-circuit-playground-express/circuitpython-quickstart)
   - [Download the latest version of the Adafruit CPX library](https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries)
-- For developers:
-  - [Steps to run the extension locally](/docs/developers-setup.md)
 
-## How to use
+### How to use
 
 To use Device Simulator Express, install the extension from the marketplace and reload VS Code.
 
-### 1. Start with the "New File" Command.
+#### 1. Start with the "Device Simulator Express [Circuit Playground Express]: New File" Command.
 
-1. Type in `"Device Simulator Express: New File"` in the command palette (`CTRL+SHIFT+P` to open the command palette).  
+1. Type in `"Device Simulator Express: [Circuit Playground Express] New File"` in the command palette (`CTRL+SHIFT+P` to open the command palette).  
    <img alt='"New File" animation' src=https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/newFile.gif>
 2. Name and save your file somewhere, and we’re good to go! (3)
-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: New File"` Command.
+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.
 
 <img alt='How to find example code screenshot' src=https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/findExamples.jpg>
 
-### 2. Start from an existing python file.
+#### 2. Start from an existing python file.
 
 1. Open the folder or your .py file in Visual Studio Code.
-2. Run `open Simulator` from the command palette or icon in the editor toolbar.
+2. Run `Device Simulator Express: [Circuit Playground Express] Open Simulator` from the command palette or icon in the editor toolbar.
 
-### 3. Run your code on the simulator.
+#### 3. Run your code on the simulator.
 
 <img alt='How to run the simulator animation' src='https://github.com/microsoft/vscode-python-devicesimulator/blob/dev/assets/readmeFiles/run.gif?raw=true'>
 
 - Run `Run Simulator` from the command palette or icon in the editor toolbar.
 - You can use the `Play` or `Refresh` button on the simulator webview.
 
-### 4. Deploy your code to the physical device
+#### 4. Deploy your code to the physical device
 
 Before deploying the python code to your CPX device, you need to format your device following these tutorials:
 
@@ -115,14 +107,14 @@ Then, if you are on Windows, you will also need to install the Python Pywin32 pa
 
 <img alt="Deploy to Device" src=https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/deployToBoard.png>
 
-### 5. Use the Serial Monitor for your Adafruit CPX device (available on Windows and Mac only)
+#### 5. Use the Serial Monitor for your Adafruit CPX device (available on Windows and Mac only)
 
 1. Plug in your CPX device (make sure it’s formatted properly already)
-2. Run the command `"Device Simulator Express: Open Serial Monitor"`
+2. Run the command `"Device Simulator Express: [Circuit Playground Express] Open Serial Monitor"`
 3. Select your baud rate for the serial port
 4. The print() statements in your code will show in the output console
 
-### 6. Use the sensors in the Device Simulator Express
+#### 6. Use the sensors in the Device Simulator Express
 
 Generating input for the sensors can be done by interacting directly with device on the webview
 or by using the toolbar.
@@ -131,25 +123,25 @@ or by using the toolbar.
 - **Temperature sensor, Light sensor, acceleration:** click on the corresponding button in the toolbar and change the value using the slider or the input box attached to it.
 - **Shake detection:** go to the motion sensor section in the toolbar and click on the shake button.
 
-### 7. Debug your project on the simulator
+#### 7. Debug your project on the simulator
 
 1. Add breakpoints in your code
 2. Press F5 to enter the debugging mode, and you can start debugging line by line!
 
-## Commands
+### Commands
 
 Device Simulator Express provides several commands in the Command Palette (F1 or Ctrl + Shift + P/ Cmd + Shift + P for Mac OS) for working with \*.py files:
 
-- `Device Simulator Express: New File`: Opens an unsaved .py file with template code, also opens the simulator.
-- `Device Simulator Express: Open Simulator`: Opens the simulator in the webView
-- `Device Simulator Express: Run on Simulator`: Runs python code on the simulator
-- `Device Simulator Express: Deploy to Device`: Copies & Pastes the code.py or main.py file to CIRCUITPY drive if detected a CPX is plugged in
-- `Device Simulator Express: Open Serial Monitor`: Opens the serial monitor in the integrated output window.
-- `Device Simulator Express: Close Serial Monitor`: Stops the serial monitor and releases the serial port.
-- `Device Simulator Express: Change Baud Rate`: Changes the baud rate of the selected serial port. For Adafruit CPX, the default baud rate is 115200.
-- `Device Simulator Express: Select Serial Port`: Changes the current serial port.
+- `Device Simulator Express: [Circuit Playground Express] New File`: Opens an unsaved .py file with template code, also opens the simulator.
+- `Device Simulator Express: [Circuit Playground Express] Open Simulator`: Opens the simulator in the webView
+- `Device Simulator Express: [Circuit Playground Express] Run on Simulator`: Runs python code on the simulator
+- `Device Simulator Express: [Circuit Playground Express] Deploy to Device`: Copies & Pastes the code.py or main.py file to CIRCUITPY drive if detected a CPX is plugged in
+- `Device Simulator Express: [Circuit Playground Express] Open Serial Monitor`: Opens the serial monitor in the integrated output window.
+- `Device Simulator Express: [Circuit Playground Express] Close Serial Monitor`: Stops the serial monitor and releases the serial port.
+- `Device Simulator Express: [Circuit Playground Express] Change Baud Rate`: Changes the baud rate of the selected serial port. For Adafruit CPX, the default baud rate is 115200.
+- `Device Simulator Express: [Circuit Playground Express] Select Serial Port`: Changes the current serial port.
 
-## Keybindings
+### Keybindings
 
 In Device Simulator Express, you can use keyboard to interact with the device:
 
@@ -158,6 +150,37 @@ In Device Simulator Express, you can use keyboard to interact with the device:
 - Slider Switch: `SHIFT + S`
 - Refresh the simulator: `SHIFT + R`
 
+
+## BBC micro:bit Simulator
+>**NOTE 1**: this feature is hidden by default. To use it, enable the feature flag in the "deviceSimulatorExpress.previewMode" user setting.
+
+>**NOTE 2**: micro:bit simulation is still in development. Features may not work as intended.
+
+### Features
+- IntelliSense and syntax highlighting for micro:bit code 
+- Template file generation
+- Integrated Python Debugging for the Simulator
+- Simulation of the micro:bit device, including:
+  - 25 LEDs
+  - Light sensor
+  - Motion sensors
+  - Acceleration detection
+  - Temperature sensor
+
+### How to use
+Using the simulator for the micro:bit is similar to using the one for the CPX. The only difference is that the commands in the command palette display `Device Simulator Express: [micro:bit] <command>` instead of `Device Simulator Express: [Circuit Playground Express] <command>`. Currently, we support the following commands for micro:bit:
+- `Device Simulator Express: [micro:bit] Open Simulator`: Opens an unsaved .py file with template code, also opens the simulator.
+- `Device Simulator Express: [micro:bit] New File`: Opens the simulator in the webView
+
+Please review the CPX's ["How to use" guide](#How-to-use) for more info.
+
+### Keybindings
+- Push Button `A & B: A B`
+- Refresh the simulator: `SHIFT + R`
+
+## Contribute
+[See here for steps to run the extension locally.](/docs/developers-setup.md)
+
 ## Provide feedback
 
 To report issues, provide feedback or requests, please use this link: [Provide Feedback](https://aka.ms/AA5xpxx).  
@@ -196,7 +219,7 @@ A `ThirdPartyNotices.txt` file is provided in the extension's source code listin
 - While running a code file, if you get an error saying it can't find the file, make sure you've clicked on a valid Python code file before running it.
 - To open the output panel again after closing it go to VS Code menu: `View->Output`.
 - If you try to deploy to the device while it's plugged in but you still get an error saying it cannot find the board, make sure your Circuit Playground Express is formatted correctly and that its name matches `CIRCUITPY`.
-- If you can't get the Simulator communication working while debugging, try to open your `Settings` and check the port used under `"Device Simulator Express: Debugger Server Port"`. You can either change it (usually ports above 5000 should work) or try to free it, then start debugging again.
+- If you can't get the Simulator communication working while debugging, try to open your `Settings` and check the port used under `"Device Simulator Express: [<device_name>] Debugger Server Port"`. You can either change it (usually ports above 5000 should work) or try to free it, then start debugging again.
 - When you are using the serial monitor, if you get some unusual error messages, unplug the device and reload the VS Code windows.
 
 ## License