p5 Contribution Workflow

p5Workflow.md

Core (p5.js)

Modifying p5 Documentation

1. Generate a p5.min.js file containing changes via npm run grunt

2. Add the new p5.min.js file to the docs directory by using ./copyfiles.sh

3. Steps 1 & 2 can be done as one-liner: npm run grunt && ./copyfiles.sh

4. Preview docs:

   1. cd docs/reference
   2. Start a server here by python3 -m http.server
      • _{Note: make sure to start a server only after running npm run grunt at least once. If docs/reference is empty, starting a sever might fail with a "FileNotFoundError"}

copyfiles.sh

#!/bin/bash

cp lib/p5.min.js docs/reference/assets/js/p5.min.js

Website (p5.js-website)

TODO