Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contributor_docs/release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Once triggered, it will run the following steps:
4. Update website files
1. Clone the website repository
2. Copy `data.json` and `data.min.json` to the right location
3. Copy `p5.min.js` and `p5.sound.min.js` to the right location
3. Copy `p5.min.js` to the right location
4. Update `data.yml` file with latest version number
5. Update `en.json` file based on `data.min.json`
6. Commit and push the changes back to the website repository
Expand All @@ -74,4 +74,4 @@ As the release steps are run in CI, testing them can be difficult. Using [act](h

The test steps will not run because not all system requirements are present to run the mocha Chrome tests. Some system dependencies will likely be needed to be installed with `apt` before setting up the rest of the environment. Keep an eye on the error messages which should give some information on what packages are missing.

The steps concerning pushing changes to remote repositories should be commented out to avoid accidentally pushing unintended changes.
The steps concerning pushing changes to remote repositories should be commented out to avoid accidentally pushing unintended changes.
19 changes: 5 additions & 14 deletions lib/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,8 @@ You have downloaded the complete p5.js library ZIP file, yay!

* p5.js file
* p5.min.js file
* addons folder
* p5.sound.js
* p5.sound.min.js
* empty-example folder
* index.html
* p5.js
* p5.sound.js
* sketch.js

## p5.js
Expand All @@ -23,21 +18,17 @@ This file stores the complete p5.js library. It is easy to read by humans, so fe

This file is a minified version of the p5.js file. It is a lighter version, with the same functionalities, but smaller file size. This minified version is harder to read for humans, and does not include the friendly error system.

## addons folder
## Sound support

The addons folder includes additional p5.js related libraries, in both original versions and minified versions.

### p5.sound.js, p5.sound.min.js

p5.sound extends p5.js with Web Audio functionality including audio input, playback, analysis, and synthesis.
p5.sound is maintained as a separate library from p5.js and is no longer included in this download. If your sketch needs sound, visit https://p5js.org/download/ for a CDN link and instructions on adding p5.sound to your project.

## empty-example folder

This is an empty example of a website. The folder includes the file for the website, index.html, the p5.js library, other related p5.js libraries, and a template starting point for your p5.js sketch, called sketch.js.
This is an empty example of a website. The folder includes the file for the website, index.html, the p5.js library, and a template starting point for your p5.js sketch, called sketch.js.

### index.html

index.html is a template for an HTML file. This index.html first imports the libraries included in the folder (p5.js, p5.sound.js) then loads and executes the file sketch.js which is where you can write your own code.
index.html is a template for an HTML file. This index.html first imports the p5.js library, then loads and executes the file sketch.js which is where you can write your own code.

### sketch.js

Expand All @@ -63,4 +54,4 @@ https://p5js.org/community/

# License

The p5.js library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 2.1.
The p5.js library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 2.1.
Loading