| 1 | # Welcome to p5.js
|
| 2 |
|
| 3 | You have downloaded the complete p5.js library ZIP file, yay!
|
| 4 |
|
| 5 | # Contents of the p5 folder
|
| 6 |
|
| 7 | * p5.js file
|
| 8 | * p5.min.js file
|
| 9 | * addons folder
|
| 10 | * p5.sound.js
|
| 11 | * p5.sound.min.js
|
| 12 | * empty-example folder
|
| 13 | * index.html
|
| 14 | * p5.js
|
| 15 | * p5.sound.js
|
| 16 | * sketch.js
|
| 17 |
|
| 18 | ## p5.js
|
| 19 |
|
| 20 | This file stores the complete p5.js library. It is easy to read by humans, so feel free to open it and explore its contents. It also has a friendly error system, which helps new programmers with common user errors.
|
| 21 |
|
| 22 | ## p5.min.js
|
| 23 |
|
| 24 | 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.
|
| 25 |
|
| 26 | ## addons folder
|
| 27 |
|
| 28 | The addons folder includes additional p5.js related libraries, in both original versions and minified versions.
|
| 29 |
|
| 30 | ### p5.sound.js, p5.sound.min.js
|
| 31 |
|
| 32 | p5.sound extends p5.js with Web Audio functionality including audio input, playback, analysis, and synthesis.
|
| 33 |
|
| 34 | ## empty-example folder
|
| 35 |
|
| 36 | 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.
|
| 37 |
|
| 38 | ### index.html
|
| 39 |
|
| 40 | 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.
|
| 41 |
|
| 42 | ### sketch.js
|
| 43 |
|
| 44 | The sketch.js is a template for the p5.js sketch, with the functions setup() and draw() that you can complete.
|
| 45 |
|
| 46 | ## README.txt
|
| 47 |
|
| 48 | This README file formatted with Markdown :)
|
| 49 |
|
| 50 | # What's next?
|
| 51 |
|
| 52 | If you need more information to help get you started, please refer to our website:
|
| 53 | https://p5js.org/get-started/ and https://p5js.org/learn/
|
| 54 |
|
| 55 | An online reference to the p5.js library is available here:
|
| 56 | https://p5js.org/reference/
|
| 57 |
|
| 58 | In order to run your website (including the empty-example), you need to enable a local server, please see this tutorial in our wiki:
|
| 59 | https://github.com/processing/p5.js/wiki/Local-server
|
| 60 |
|
| 61 | p5.js is a community and p5.js is built by contributions. If you want to learn more about us, visit:
|
| 62 | https://p5js.org/community/
|
| 63 |
|
| 64 | # License
|
| 65 |
|
| 66 | 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.
|