Skip to content

Commit d3cd8bb

Browse files
committed
Merge branch 'more-libraries' into update-libraries
2 parents 69aa210 + 02a283d commit d3cd8bb

File tree

574 files changed

+9148
-5315
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

574 files changed

+9148
-5315
lines changed

contributing_libraries.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,21 @@
33
p5.js welcomes libraries contributed by others! <a href="https://github.com/processing/p5.js/blob/main/contributor_docs/creating_libraries.md">Check out the libraries tutorial</a> for more specifics about how to create one. If you have created a library and would like to have it included in the list, follow the instructions below!
44

55
1. Fork the repo
6-
2. Add a file to the `src/content/libraries` folder named `yourLibraryName.yaml`
6+
2. Add a file to the `libraries` folder named `yourLibraryName.yaml` (or consider <a href="src/content/libraries/en/p5.warp.yaml">copying an existing library</a> as a starting point)
77
3. Inside it, add the following content:
88
- `name`: The name of the library
9-
- `category`: A category that you think best fits your library. Your choices include: `drawing`, `color`, `ui`, `math`, `physics`, `algorithms`, `3d`, `ai-ml-cv`, `animation`, `filters`, `language`, `hardware`, `sound`, `data`, `networking`, `export`, or `utils`.
9+
- `category`: A category that you think best fits your library. Your choices include: `drawing`, `color`, `ui`, `math`, `physics`, `algorithms`, `3d`, `ai-ml-cv`, `animation`, `shaders`, `language`, `hardware`, `sound`, `data`, `networking`, `export`, or `utils`.
1010
- `description`: A one-sentence description of the library
11-
- `author`: An object containing `name`, your name, and `url`, an optional link to your website
11+
- `author`: An object containing `name`, your name, and `url`, an optional link to your website. If there are multiple authors, use an array of author objects.
1212
- `sourceUrl`: A link to the library's source code (e.g. its repo on GitHub or GitLab)
1313
- (Optional) `websiteUrl`: A link to a website for the library
1414
- (Optional) `npm`: If applicable, the package name for the library on <a href="https://www.npmjs.com/">npm</a>
15-
- (Optional) `npmFilePath`: A path like `'dist/library.min.js'` if a specific file in the library should be used from npm
16-
- `featuredImage`: An object about the preview thumbnail for the library, with `url`, the path to the image in the `src/content/libraries/images` folder, and `altText`, a short description of its contents for screen readers
15+
- (Optional) `npmFilePath`: A path like `'dist/library.min.js'` if a specific file in the library should be used from npm. You can test this out by going to `https://cdn.jsdelivr.net/npm/packageName` -- if that doesn't work, try `https://cdn.jsdelivr.net/npm/packageName/path/to/file.js` and put the path you added into this property
16+
- `featuredImage`: An object about the preview thumbnail for the library, with `url`, the relative path to the image in the `src/content/libraries/images` folder, and `altText`, a short description of its contents for screen readers
1717
- (Optional) `license`: A <a href="https://docs.npmjs.com/cli/v10/configuring-npm/package-json#license">string describing the software license of the library.</a> This may be omitted if your package is on npm and has license info there
18-
4. Add a **1500x1000** image of your library into `src/content/libraries/images`
18+
4. Add a **high-res colored image of 1500x1000px** of your library into `src/content/libraries/images`
1919
5. Submit a pull request and we'll review your submission
2020

2121
We add libraries that are open-source, includes some documentation and examples, and <a href="https://github.com/processing/p5.js/blob/main/CODE_OF_CONDUCT.md">follow our code of conduct.</a>
22+
23+
If you have any questions, feel free to open an issue or create a work-in-progress PR and ask us anything!

src/content/examples/en/00_Structure/01_Coordinates/description.mdx

-13
This file was deleted.

src/content/examples/en/00_Structure/02_Width_and_Height/code.js

-15
This file was deleted.

src/content/examples/en/00_Structure/02_Width_and_Height/description.mdx

-13
This file was deleted.

src/content/examples/en/00_Structure/03_Setup_and_Draw/code.js

-23
This file was deleted.

src/content/examples/en/00_Structure/03_Setup_and_Draw/description.mdx

-11
This file was deleted.

src/content/examples/en/00_Structure/04_No_Loop/code.js

-26
This file was deleted.

src/content/examples/en/00_Structure/04_No_Loop/description.mdx

-8
This file was deleted.

src/content/examples/en/00_Structure/05_Loop/code.js

-27
This file was deleted.

src/content/examples/en/00_Structure/05_Loop/description.mdx

-12
This file was deleted.

src/content/examples/en/00_Structure/06_Redraw/code.js

-29
This file was deleted.

src/content/examples/en/00_Structure/06_Redraw/description.mdx

-10
This file was deleted.

src/content/examples/en/00_Structure/07_Functions/code.js

-23
This file was deleted.

src/content/examples/en/00_Structure/07_Functions/description.mdx

-11
This file was deleted.

src/content/examples/en/00_Structure/08_Recursion/description.mdx

-14
This file was deleted.

src/content/examples/en/00_Structure/09_Create_Graphics/code.js

-24
This file was deleted.

src/content/examples/en/00_Structure/09_Create_Graphics/description.mdx

-11
This file was deleted.

src/content/examples/en/01_Form/00_Points_and_Lines/description.mdx

-9
This file was deleted.

src/content/examples/en/01_Form/01_Shape_Primitives/code.js

-25
This file was deleted.

src/content/examples/en/01_Form/01_Shape_Primitives/description.mdx

-13
This file was deleted.

src/content/examples/en/01_Form/02_Pie_Chart/description.mdx

-10
This file was deleted.

src/content/examples/en/01_Form/03_Regular_Polygon/description.mdx

-12
This file was deleted.

src/content/examples/en/01_Form/04_Star/description.mdx

-11
This file was deleted.

0 commit comments

Comments
 (0)