Skip to content

Commit 0aeccea

Browse files
committed
Update README adding MicroPython, some styling and some refactoring
Signed-off-by: paulober <[email protected]>
1 parent 47bd248 commit 0aeccea

File tree

1 file changed

+32
-17
lines changed

1 file changed

+32
-17
lines changed

README.md

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Raspberry Pi Pico Visual Studio Code extension
22

3-
> NOTE: The extension is currently under development.
3+
> **Note: The extension is currently under development.**
44
55
This is the official Visual Studio Code extension for Raspberry Pi Pico development. This extension equips you with a suite of tools designed to streamline your Pico projects using Visual Studio Code and the official [Pico SDK](https://github.com/raspberrypi/pico-sdk).
66

@@ -10,18 +10,33 @@ For comprehensive setup instructions, refer to the [Getting Started guide](https
1010

1111
## Features
1212

13-
- Project Generator: Easily create new projects targeting the Ninja build system.
14-
- Automatic CMake Configuration: Automatically configures CMake when loading a project.
15-
- Version Switching: Seamlessly switch between different versions of the Pico SDK and tools.
16-
- No Manual Setup Required: The extension handles environment variables, toolchain, SDK, and tool management for you.
17-
- One-Click Compilation: Compile projects directly from the status bar with your selected SDK and tools.
18-
- Offline Documentation: Access Pico SDK documentation offline.
19-
- Quick Project Setup: Quickly create new Pico projects from the Explorer view when no workspace is open.
20-
- Includes an Uninstaller: Easily remove the extension along with all automatically installed tools and SDKs.
13+
### Project Setup and Management
14+
15+
- **Project Generator**: Easily create and configure new projects with support for advanced Pico features like I2C and PIO. The generator targets the Ninja build system and allows customization during project creation.
16+
- **Quick Project Setup**: Initiate new Pico projects directly from the Explorer view, when no workspace is open.
17+
- **MicroPython Support**: Create and develop MicroPython-based Pico projects with support provided through the [MicroPico](https://github.com/paulober/MicroPico) extension.
18+
19+
### Configuration and Tool Management
20+
21+
- **Automatic CMake Configuration**: Automatically configures CMake when loading a project.
22+
- **Version Switching**: Seamlessly switch between different versions of the Pico SDK and tools.
23+
- **No Manual Setup Required**: Automatically handles environment variables, toolchain, SDK, and tool management.
24+
25+
### Build, Debug, and Documentation
26+
27+
- **One-Click Compilation and Debugging**: Automatically configure OpenOCD, Ninja, and CMake, allowing you to compile and debug with a single click.
28+
- **Offline Documentation**: Conveniently access Pico SDK documentation directly within the editor, even when offline.
29+
30+
- **Version Switching**: Seamlessly switch between different versions of the Pico SDK and tools.
31+
- **No Manual Setup Required**: The extension handles environment variables, toolchain, SDK, and tool management for you.
32+
- **One-Click Compilation**: Compile projects directly from the status bar with your selected SDK and tools.
33+
- **Offline Documentation**: Access Pico SDK documentation offline.
34+
- **Quick Project Setup**: Quickly create new Pico projects from the Explorer view when no workspace is open.
35+
- **MicroPython Support**: Create MicroPython-based Pico projects with support provided through the MicroPico extension.
2136

2237
## Requirements by OS
2338

24-
> Supported Platforms: Raspberry Pi OS (64-bit), Windows 10/11 (x86_64), macOS Sonoma (14.0) and newer, Linux x64 and arm64
39+
> **Supported Platforms: Raspberry Pi OS (64-bit), Windows 10/11 (x86_64), macOS Sonoma (14.0) and newer, Linux x64 and arm64**
2540
2641
- Visual Studio Code v1.87.0 or later
2742

@@ -38,19 +53,19 @@ To meet the requirements for macOS, run the following command in Terminal to ins
3853
xcode-select --install
3954
```
4055
This command installs all of the necessary tools, including but not limited to:
41-
- Git 2.28 or later (ensure it's in your PATH)
42-
- Tar (ensure it's in your PATH)
56+
- **Git 2.28 or later** (ensure it's in your PATH)
57+
- **Tar** (ensure it's in your PATH)
4358

4459
### Windows
4560

4661
No additional requirements are needed for Windows.
4762

4863
### Linux
49-
- Python 3.9 or later (ensure it’s in your PATH or set in settings)
50-
- Git 2.28 or later (ensure it’s in your PATH)
51-
- Tar (ensure it’s in your PATH)
52-
- \[Optional\] gdb-multiarch for debugging (x86_64 only)
53-
- For \[Ubuntu 22.04\], install `libftdi1-2` and `libhidapi-hidraw0` packages to use OpenOCD
64+
- **Python 3.9 or later** (ensure it’s in your PATH or set in settings)
65+
- **Git 2.28 or later** (ensure it’s in your PATH)
66+
- **Tar** (ensure it’s in your PATH)
67+
- **\[Optional\]** gdb-multiarch for debugging (x86_64 only)
68+
- For **\[Ubuntu 22.04\]**, install `libftdi1-2` and `libhidapi-hidraw0` packages to use OpenOCD
5469

5570
## Extension Settings
5671

0 commit comments

Comments
 (0)