Skip to content

Commit 23b6807

Browse files
authored
Update README.md
Add features, todo, demo video
1 parent cca330b commit 23b6807

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

p5js/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,34 @@
77
Install the mode by double-clicking the released `.pdex` file. After Processing has started up, hit "Yes" on the opening dialog, and let the mode get installed into your Processing sketchbook folder. Currently, you need to restart Processing to have the new p5.js mode show up in the mode dropdown. (This will be looked into for the September release candiate that will be published until September 30 end of day.)
88

99
After restarting Processing, choose “p5.js” from the mode dropdown. If `pnpm` is not found on your system, Processing will automatically install it and the LTS Node version. The status bar in the PDE will tell you once it is ready for you to code on your sketch.
10+
11+
## Demo
12+
13+
https://github.com/user-attachments/assets/f934430d-a71c-4995-8e20-92471e400013
14+
15+
## Features
16+
17+
- Auto-install of `pnpm`, Node, and all dependencies for running p5.js code inside the PDE
18+
- Error reporting
19+
- [Syntax highlighting](https://github.com/stephanmax/processing4/wiki/Syntax-Highlighting)
20+
- Installing `npm` dependencies
21+
22+
## Known Issues/ToDos
23+
24+
- Installation
25+
- Prepare and test `.pdex` for Windows
26+
- Editor UI/UX
27+
- Better information in the status bar (`pnpm` version, remove status messages in due time)
28+
- More stability around processes/coroutines (repeatedly pressing Run button should simplu restart the sketch)
29+
- Better/responsive npm (de-)install UI
30+
- Mode options
31+
- Start sketch in correct dimensions
32+
- Update `index.html` if sketch files are changed
33+
- Button to open dev tools in Electron
34+
- Hiding non-sketch files from tabs
35+
- Ignore `node_modules` when saving/exporting
36+
- Error handling
37+
- Run linter for error messaging without having to run the sketch
38+
- Remove error messaging when error is fixed
39+
- Features
40+
- Stand-alone app export

0 commit comments

Comments
 (0)