Skip to content

Commit 88eff1b

Browse files
docs: revise build instructions to remove Grunt commands
1 parent 083bae8 commit 88eff1b

1 file changed

Lines changed: 6 additions & 15 deletions

File tree

contributor_docs/archive/custom_p5_build.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,20 @@ This feature was suggested as a part of a proposal for Google Summer of Code 201
1010

1111
## Usage
1212

13-
Currently, the usage is through invoking a Grunt task manually from the command line:
13+
14+
p5.js has migrated to modern tooling. Use the following to build and test:
1415

1516
```sh
1617
git clone https://github.com/processing/p5.js.git
1718
cd p5.js
1819
npm ci
19-
npm run grunt
20-
npm run grunt combineModules:module_x:module_y
20+
npm run build # builds the full p5.js bundle
21+
npm test # runs linter and tests using Vitest
2122
```
2223

23-
Here, `module_n` refers to the name of the modules which you want to select. Multiple modules must be passed as shown above. Also, these modules must have the same name as their folders in `/src` directory to work correctly. While `core` is included by default, `core/shape` needs to be included for shapes like line() and other core features to work.
24-
25-
The above usage example will likely output a `p5Custom.js` larger than the complete `p5.min.js` as the output is not minified using the `uglify` task.
24+
To include only selected modules in a custom build, refer to the CONTRIBUTING guide or module-specific documentation. Rollup or tree-shaking through ES modules may be used for advanced setups.
2625

27-
The recommended steps to reduce bundle size as much as possible are:
28-
29-
```sh
30-
git clone https://github.com/processing/p5.js.git
31-
cd p5.js
32-
npm ci
33-
npm run grunt
34-
npm run grunt combineModules:min:module_x:module_y uglify
35-
```
26+
---
3627

3728
## Examples
3829

0 commit comments

Comments
 (0)