Skip to content

Commit 19dfab7

Browse files
committed
Revise and reorganize README for clarity
Improves the README by restructuring sections for easier onboarding, clarified prerequisites and installation steps, and updated troubleshooting.
1 parent 9666e5c commit 19dfab7

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

README.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,27 @@ Create and run Processing sketches in Visual Studio Code.
66

77
![Processing VS Code Extension Screenshot](.github/media/screenshot.png)
88

9-
This extension adds support for Processing sketches in VSCode. Includes familiar run and stop buttons, syntax highlighting, code suggestions, and easy access to your sketchbook and examples. If you prefer coding in VS Code, this extension makes it easier to work with Processing.
9+
This extension adds support for Processing sketches in VSCode. It includes familiar run and stop buttons, syntax highlighting, code suggestions, and easy access to your sketchbook and examples.
1010

11-
## Requirements
12-
13-
You will need **Processing 4.4.6 or later** installed on your computer ([Download Processing](https://processing.org)).
11+
## Getting Started
1412

15-
**IMPORTANT:** Run Processing at least once after installing it. This creates the files the extension needs.
13+
### Prerequisites
1614

17-
## Features
15+
Before you begin, make sure to:
1816

19-
* Run and stop sketches directly in VS Code
20-
* Browse your sketchbook and open example sketches
21-
* Syntax highlighting for Processing code
22-
* Code suggestions and error checking with the Processing Language Server
23-
* Automatic detection of your Processing installation (no manual configuration required)
17+
- Install **Processing 4.4.6 or later** ([Download Processing](https://processing.org))
18+
- Run Processing at least once after installing it. This creates the files the extension needs.
19+
- Uninstall any previously installed Processing extensions. This extension may conflict with other Processing extensions, leading to unexpected behavior.
2420

25-
## Install
21+
### Installation
2622

27-
Install the extension from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/) or search for "Processing" in the [Extension Marketplace](https://code.visualstudio.com/docs/configure/extensions/extension-marketplace) within VS Code.
23+
Install the extension from the [Visual Studio Marketplace](https://vscode.processing.org/) or search for "Processing" in the [Extension Marketplace](https://marketplace.visualstudio.com/). You can also install it directly from VS Code by searching for "Processing" in the Extensions view (`Ctrl + Shift + X` or `Cmd + Shift + X` on macOS). Pick the extension published by "Processing Foundation".
2824

29-
## Getting Started
25+
### Running Your First Sketch
3026

31-
1. Install the Processing extension for VS Code.
32-
2. Click the Processing icon in the Activity Bar on the side of the VS Code window.
33-
3. Open a sketch from your sketchbook or from the examples.
34-
4. Click the Run button to start your sketch.
27+
1. Click the Processing icon in the Activity Bar on the side of the VS Code window.
28+
2. Open a sketch from your sketchbook or from the examples.
29+
3. Click the Run button to start your sketch.
3530

3631
When you run a sketch, a terminal will open at the bottom of VS Code to show the build output, and the Processing sketch window will appear.
3732

@@ -46,16 +41,25 @@ You can customize the extension in VS Code settings
4641
- `processing.newWindow`: Opens sketches in a new VS Code window. If disabled, sketches open in the current window. Default: `true`.
4742
- `processing.version`: Choose which installed Processing version to use. Default is `latest`, but you can specify a version (e.g., `4.4.6`).
4843

44+
## Known Issues
45+
46+
* Some Processing constants (like `PI`, `RGB`, `DEGREES`) are not highlighted yet
47+
* Classes from third-party libraries are not recognized by the language server (sketches still run fine). See [this issue](https://github.com/processing/processing-vscode-extension/issues/9)
48+
* The extension includes a bundled JDK for macOS, Windows, and Linux. This increases the extension size, but is necessary for reliably detecting your Processing installation across platforms. Eventually, we hope to remove this dependency and rely on the Processing CLI instead.
49+
4950
## Troubleshooting
5051

5152
If something doesn’t work:
5253

53-
* Close any running Processing sketches or editor windows
54-
* Remove any other Processing extensions that might conflict with this one
5554
* Close VSCode
56-
* Check you have installed Processing 4.4.6
57-
* Run the Processing editor once
58-
* Restart VSCode
55+
* Remove any other Processing extensions you may have installed
56+
* Install the latest version of Processing (4.4.6 or later)
57+
* Close any running Processing sketches or editor windows
58+
* Run the Processing editor (PDE) once
59+
60+
After following these steps, reopen VSCode and try again.
61+
62+
If you still encounter issues, please ask on the [Processing Forum](https://discourse.processing.org) or check the [GitHub Issues page](https://github.com/processing/processing-vscode-extension/issues).
5963

6064
## Compatibility
6165

@@ -65,12 +69,6 @@ The extension has been tested on:
6569
* Windows 64-bit
6670
* Linux 64-bit
6771

68-
## Known Issues
69-
70-
* Some Processing constants (like `PI`, `RGB`, `DEGREES`) are not highlighted yet
71-
* Classes from third-party libraries are not recognized by the language server (sketches still run fine). See [this issue](https://github.com/processing/processing-vscode-extension/issues/9)
72-
* The extension includes a bundled JDK for macOS, Windows, and Linux. This increases the extension size, but is necessary for reliably detecting your Processing installation across platforms. Eventually, we hope to remove this dependency and rely on the Processing CLI instead.
73-
7472
## Contributing
7573

7674
This project is still growing, and contributions are welcome!

0 commit comments

Comments
 (0)