Skip to content

Commit 1ce0206

Browse files
committed
Merge branch 'master' of github.com:processing/p5.js
2 parents 7b842f8 + 27ece1e commit 1ce0206

File tree

8 files changed

+173
-119
lines changed

8 files changed

+173
-119
lines changed

README.md

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,69 @@
22

33
# [p5.js](http://p5js.org)
44

5-
Hello! p5.js is a JavaScript library that starts with the original goal of Processing, to make coding accessible for artists, designers, educators, and beginners, and reinterprets this for today's web.
5+
Welcome! 👋👋🏿👋🏽👋🏻👋🏾👋🏼
66

7-
Using the original metaphor of a software sketchbook, p5.js has a full set of drawing functionality. However, you're not limited to your drawing canvas, you can think of your whole browser page as your sketch! For this, p5.js has addon libraries that make it easy to interact with other HTML5 objects, including text, input, video, webcam, and sound.
7+
p5.js is a JavaScript library for creative coding, with a focus on making coding accessible and inclusive for artists, designers, educators, beginners, and anyone else! p5.js is free and open-source because we believe software, and the tools to learn it, should be accessible to everyone.
88

9-
p5.js is a new interpretation, not an emulation or port, and it is in active development. An official editing environment is coming soon, as well as many more features!
9+
Using the metaphor of a sketch, p5.js has a full set of drawing functionality using the HTML5 canvas element. You’re not limited to the drawing canvas though. You can think of your whole browser page as your sketch, including HTML5 objects for text, input, video, webcam, and sound.
1010

11-
If you already know the basics of JavaScript or Processing, the [p5.js overview](https://github.com/processing/p5.js/wiki/p5.js-overview) wiki page is a good place to start.
11+
p5.js draws inspiration, wisdom, and guidance from its precursor [Processing](https://processing.org). However, it is a new interpretation, not an emulation or port. We don't aim to match Processing's set of functionality exactly, allowing ourselves space to deviate and grow in the context of the web.
1212

13-
If you have found a bug in the p5.js library, you can file it here under the [“issues” tab](https://github.com/processing/p5.js/issues). An indicative template for reporting an issue is provided to assist you (and us!) better.
13+
The [p5js.org](https://p5js.org) website contains an extensive overview of the project, community, documentation, and examples. If you already know the basics of JavaScript or Processing, the [p5.js overview](https://github.com/processing/p5.js/wiki/p5.js-overview) wiki page is a good place to start.
1414

15-
## p5.js library
15+
## Community
1616

17-
To use the complete p5.js library, you can [download it here](http://p5js.org/download). If you are interested in the most recent, less stable version, or even simply in (**new!**) certain components of p5.js, you can clone this repository and run `grunt` from the command line to generate the library from source. See the [developer docs](https://github.com/processing/p5.js/blob/master/contributor_docs/) for more information about our build process to generate the complete as well as selective library.
17+
We are a community of, and in solidarity with, people from every gender identity and expression, sexual orientation, race, ethnicity, language, neuro-type, size, ability, class, religion, culture, subculture, political opinion, age, skill level, occupation, and background. We acknowledge that not everyone has the time, financial means, or capacity to actively participate, but we recognize and encourage involvement of all kinds. We facilitate and foster access and empowerment. We are all learners.
1818

19-
You can also start with the [codepen template](https://codepen.io/p5js/pen/wreBKy). You may need to update the version of the p5.js library that is linked into the html section.
19+
p5.js is a collaborative project created by many individuals, mostly volunteers, and you are invited to help. All types of involvement are welcome. See the [community section](http://p5js.org/community) to get started! You can also check out the [contributor docs](https://github.com/processing/p5.js/blob/master/contributor_docs/) for more in-depth details about contributing to different areas of the project, including code, bug fixes, documentation, discussion, and more.
2020

21-
Community maintained typescript definitions are [here](https://github.com/p5-types/p5.ts).
21+
Learn more about [our community](https://p5js.org/community/) and read our community statement. You can directly support our work with p5.js by [donating to the Processing Foundation](https://processingfoundation.org/support).
22+
23+
## Get Started
24+
25+
Make your first sketch in the [p5.js Editor](https://editor.p5js.org/)! Learn more about sketching with p5.js on the [Get Started](https://p5js.org/get-started/) and find everything you can do in the [Reference](https://p5js.org/reference/).
26+
27+
To get the complete p5.js library on your own computer, you can [download it here](http://p5js.org/download). If you are interested in the most recent, less stable version, or even simply in (**new!**) certain components of p5.js, you can clone this repository and run `grunt` from the command line to generate the library from source. See the [contributor docs](https://github.com/processing/p5.js/blob/master/contributor_docs/) for more information about our build process.
2228

2329
## Issues
2430

25-
Please post bugs in the correct repository:
31+
If you have found a bug in the p5.js library, you can file it here under the [“issues” tab](https://github.com/processing/p5.js/issues). You can also request new features here. A set of templates for reporting issues and requesting features are provided to assist you (and us!). p5.js is maintained mostly by volunteers, so we thank you for your patience as we try to address your issues as soon as we can. Please post in the correct repository if you can:
2632

27-
* p5.js general and p5.dom: [https://github.com/processing/p5.js/issues](https://github.com/processing/p5.js/issues)
33+
* p5.js general: [https://github.com/processing/p5.js/issues](https://github.com/processing/p5.js/issues)
2834
* p5.sound: [https://github.com/processing/p5.js-sound/issues](https://github.com/processing/p5.js-sound/issues)
2935
* p5.js website: [https://github.com/processing/p5.js-website/issues](https://github.com/processing/p5.js-website/issues)
3036
* p5.js web editor: [https://github.com/processing/p5.js-web-editor/issues](https://github.com/processing/p5.js-web-editor/issues)
3137

3238

3339
## Learning
3440

35-
Check out [p5js.org](http://p5js.org) for lots more! Here are some quick-links:
41+
Check out [p5js.org](http://p5js.org) for lots more! Here are some quick-links to get started learning p5.js.
3642

3743
* [Get Started](http://p5js.org/get-started): Create and run your first sketch!
38-
* [p5.js overview](https://github.com/processing/p5.js/wiki/p5.js-overview)An overview of the main features and functionality of p5.js.
39-
* [Reference](http://p5js.org/reference): The functionality supported by p5.js.
40-
* [Learn](//p5js.org/learn): Tutorials and short, prototypical examples exploring the basics of p5.js.
41-
* [Forum](http://forum.processing.org/two/categories/p5-js): Ask and answers questions about how to make things with p5.js here.
44+
* [p5.js overview](https://github.com/processing/p5.js/wiki/p5.js-overview): An overview of the main features and functionality of p5.js
45+
* [Reference](http://p5js.org/reference): The functionality supported by p5.js
46+
* [Learn](//p5js.org/learn): Tutorials and short, prototypical examples exploring the basics of p5.js
47+
* [Forum](http://forum.processing.org/two/categories/p5-js): Ask and answers questions about how to make things with p5.js here
4248
* [Libraries](http://p5js.org/libraries): Extend p5 functionality to interact with HTML, manipulate sound, and more!
49+
* [The Coding Train p5.js Tutorials](https://thecodingtrain.com/Tutorials/): A huge trove of tutorials created by Dan Shiffman and friends
4350

44-
## Get Involved
51+
## Stewards
4552

46-
p5.js is a collaborative project created by many individuals, and you are invited to help. All types of involvement are welcome. See the [community section](http://p5js.org/community) to get started!
53+
Stewards are contributors that are particularly involved, familiar, or responsive to certain areas of the project. Their role is to help provide context and guidance to others working on p5.js. If you have a question about contributing to a particular area, you can tag the listed steward in an issue or pull request. They may also weigh in on feature requests and guide the overall direction of their area, with the input of the community. You can read more about the organization of the project at [contributor_docs/organization.md](https://github.com/processing/p5.js/blob/master/contributor_docs/organization.md).
4754

48-
Developers, check out the [developer docs](https://github.com/processing/p5.js/blob/master/contributor_docs/) for more in-depth details about contributing code, bug fixes, and documentation.
55+
Anyone interested can volunteer to be a steward! There are no specific requirements for expertise, just an interest in actively learning and participating. If you’re familiar with one or more parts of this project, open an issue to volunteer as a steward!
56+
57+
* [@lmccart](https://github.com/lmccart) project lead
58+
* more to come...
4959

5060
## Contributors
5161

52-
We recognize all types of contributions. This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Instructions to add yourself or add contribution emojis to your name are [here](https://github.com/processing/p5.js/issues/2309).
62+
We recognize all types of contributions. This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Instructions to add yourself or add contribution emojis to your name are [here](https://github.com/processing/p5.js/issues/2309). You can also post an issue or comment with the text: `@all-contributors please add @YOUR-USERNAME for THING(S)` and our nice bot will add you.
5363

5464
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
5565
<!-- prettier-ignore-start -->
5666
<!-- markdownlint-disable -->
67+
5768
<table>
5869
<tr>
5970
<td align="center"><a href="http://lauren-mccarthy.com"><img src="https://avatars3.githubusercontent.com/u/191056?v=4" width="100px;" alt=""/><br /><sub><b>Lauren McCarthy</b></sub></a><br /></td>

0 commit comments

Comments
 (0)