Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: paulober <[email protected]>
  • Loading branch information
paulober committed Sep 16, 2024
1 parent f4a0c3b commit 03b22e9
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"--extensionDevelopmentPath=${workspaceFolder}"
],
"outFiles": [
"${workspaceFolder}/dist/**/*.js"
"${workspaceFolder}/dist/**/*.cjs"
],
"preLaunchTask": "${defaultBuildTask}"
},
Expand Down
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,17 @@ For comprehensive setup instructions, refer to the [Getting Started guide](https

## Requirements by OS

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

### Raspberry Pi OS
As of March 2024, all new Raspberry Pi OS images come with the necessary tools pre-installed. For older images, you can install the required tools by running:

```bash
sudo apt install openocd ninja-build
```

### macOS
To meet the requirements for macOS, run the following command in Terminal to install necessary tools:
```zsh
Expand All @@ -33,21 +40,15 @@ xcode-select --install
This command installs all of the necessary tools, including but not limited to:
- Git 2.28 or later (ensure it's in your PATH)
- Tar (ensure it's in your PATH)
- Native C/C++ compiler (ensure it's in your PATH); supported compilers include `gcc` and `clang`

### Raspberry Pi OS
As of March 2024, all new Raspberry Pi OS images come with the necessary tools pre-installed. For older images, you can install the required tools by running:
### Windows

```bash
sudo apt install openocd ninja-build
```
No additional requirements are needed for Windows.

### Linux
- Python 3.9 or later (ensure it’s in your PATH or set in settings)
- Git 2.28 or later (ensure it’s in your PATH)
- Tar (ensure it’s in your PATH)
- Native C/C++ compiler (ensure it’s in your PATH); supported compilers include `gcc` and `clang`
- \[Optional\] OpenOCD for debugging (Raspberry Pi OS only)
- \[Optional\] gdb-multiarch for debugging (x86_64 only)
- For \[Ubuntu 22.04\], install `libftdi1-2` and `libhidapi-hidraw0` packages to use OpenOCD

Expand Down
6 changes: 3 additions & 3 deletions src/commands/configureCmake.mts
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ export default class ConfigureCmakeCommand extends Command {
// check if is a pico project
if (workspaceFolder === undefined) {
this._logger.warn("No workspace folder found.");
await window.showWarningMessage("No workspace folder found.");
void window.showWarningMessage("No workspace folder found.");

return;
}

if (await configureCmakeNinja(workspaceFolder.uri)) {
await window.showInformationMessage("CMake has configured your build.");
void window.showInformationMessage("CMake has configured your build.");
} else {
await window.showWarningMessage("CMake has not configured your build.");
void window.showWarningMessage("CMake has not configured your build.");
}
}
}

0 comments on commit 03b22e9

Please sign in to comment.