Skip to content

Commit 6fb25cb

Browse files
committed
Update README and add TODOs for extension features and commands
1 parent 7ca713a commit 6fb25cb

File tree

4 files changed

+8
-12
lines changed

4 files changed

+8
-12
lines changed

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
# Processing VSCode Extension
22

3-
<!-- TODO: Write the README -->
4-
<!-- TODO: Add general Processing Foundation repository contents -->
5-
6-
<!-- TODO: Check for other Processing plugins and request deactivation if they are installed -->
73
<!-- TODO: Generate grammar based on the installed Processing version -->
84
<!-- TODO: Setup publishing https://code.visualstudio.com/api/working-with-extensions/publishing-extension -->
9-
<!-- TODO: Merge changes to Processing https://github.com/processing/processing4/pull/1115 -->
105

116
<!-- TODO: add a link to the extension Marketplace page -->
127

@@ -17,10 +12,10 @@ This extension provides support for the Processing programming language in Visua
1712
With familiar run and stop buttons, syntax highlighting, and other helpful features like code suggestions, this extension is designed to support creative coding with Processing for people who prefer using Visual Studio Code as their code editor of choice.
1813

1914
## Requirements
20-
To use this extension, you need to have the **preview release of Processing (4.4.76)** installed on your system. You can download it from this link: [Processing 4.4.76 Preview](https://github.com/Stefterv/processing4/releases/tag/processing-1376-4.4.76).
15+
To use this extension, you need to have the **release of Processing (4.4.6+)** installed on your system. You can download it from this link: [Processing](https://processing.org).
2116

2217
> [!IMPORTANT]
23-
> **Make sure to run Processing 4.4.76 at least once** before using the extension. This step is needed to initialize some required files.
18+
> **Make sure to run Processing 4.4.6 at least once** before using the extension. This step is needed to initialize some required files.
2419
2520
## Features
2621
- ▶️ Run / Stop buttons: Play your sketch directly in VS Code.
@@ -32,7 +27,7 @@ To use this extension, you need to have the **preview release of Processing (4.4
3227
## How to Use
3328
To use the Processing VSCode extension, follow these steps:
3429

35-
1. Install the Processing 4.4.76 preview.
30+
1. Install Processing 4.4.6 or later
3631
2. Open a `.pde` file or use the sketchbook/explorer in VS Code.
3732
3. Press ▶️ to run your sketch!
3833

@@ -54,7 +49,6 @@ This extension has been tested on the following platforms:
5449

5550
## Known issues
5651
- Play/Stop buttons don’t reflect the actual running state yet.
57-
- Snap release of Processing (Linux and WSL) is not supported yet (use the portable version instead).
5852
- Syntax highlighting for Processing-specific constants (e.g., `PI`, `RGB`, `DEGREES`, etc) is not yet implemented.
5953
- Classes imported from third-party libraries are not recognized by the language server, leading to line errors (the sketch will still run correctly) see issue [#9](https://github.com/Stefterv/processing4-vscode-extension/issues/9).
6054

client/src/extension.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export const state = {
2424
};
2525

2626
export async function activate(context: ExtensionContext) {
27-
27+
// TODO: Detect other Processing extensions and warn the user
2828

2929
await setupSelectedVersion(context);
3030
setupCommands(context);

client/src/setupCommands.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,10 @@ export function setupCommands(context: ExtensionContext) {
1818
}
1919
}
2020

21-
// TODO: If the command is run from a keyboard shortcut, find the current file
2221
if (!resource) {
2322
return;
2423
}
2524

26-
// TODO: Save the current file, maybe settting?
2725
// TODO: Give feedback if the sketch is starting
2826

2927
let terminal = state.terminal;
@@ -122,5 +120,7 @@ export function setupCommands(context: ExtensionContext) {
122120
}
123121
});
124122

123+
// TODO: Add command to select Processing version and set the setting
124+
125125
context.subscriptions.push(runSketch, stopSketch, openSketch, newSketch);
126126
}

client/src/setupSidebar.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ export interface Folder {
2222
}
2323

2424
export async function setupSidebar() {
25+
// TODO: Show welcome screens whilst we are starting Processing
26+
2527
setupExamples();
2628
setupSketchbook();
2729
}

0 commit comments

Comments
 (0)