You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started.md
+14-17Lines changed: 14 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# Getting Started
2
-
We're excited that you're interested in contributing to the Processing ecosystem! Building a library lets you expand Processing’s capabilities and it's a great way to give back by sharing your custom tools with the community.
2
+
We're excited that you're interested in contributing to the Processing ecosystem! Building a library lets you expand Processing’s capabilities, and it's a great way to give back by sharing your custom tools with the community.
3
3
4
4
This guide will help you set up your development environment and start building your library using the provided template.
5
5
6
6
7
7
## Setting up the environment
8
8
Follow these steps to create your own repository on GitHub and install the necessary tools.
9
9
10
-
1.**Create a new Github repository** using the [processing-library-template](https://github.com/processing/processing-library-template)
10
+
1.**Create a new GitHub repository** using the [processing-library-template](https://github.com/processing/processing-library-template)
11
11
as a base.
12
12
(See: [How to create a repository from a template.](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template))
13
13
Choose a name that reflects the library you're building. Make sure to read about Processing's [naming rules for libraries](https://github.com/benfry/processing4/wiki/Library-Basics#library-naming-rules). You can always rename the repository later.
@@ -21,21 +21,18 @@ Follow these steps to create your own repository on GitHub and install the neces
21
21
## Testing the Library Template
22
22
Now that your environment is set up, follow these steps to get familiar with the template and make sure everything works correctly:
23
23
24
-
1.**Open up your new repository in your chosen IDE.**
25
-
2.**Run the Gradle task `deployToProcessingSketchbook`:**
26
-
- In the Gradle menu (the elephant icon) in your IDE, navigate to `Tasks` > `processing` >
27
-
`deployToProcessingSketchbook`, and double click on `deployToProcessingSketchbook`.
28
-
- This will build the library, create the release artifacts, and copy them to the folder
29
-
where Processing libraries are stored.
30
-
3.**Check if the library appears as a contributed library:**
31
-
- Open Processing, and click on `Sketch` > `Import Library ...`.
32
-
- You should see an entry named "A Template Example Library" in the menu as `Contributed`.
33
-
This is the sample library you just installed using the template.
34
-
- If it does not appear, please check the [troubleshooting guide](troubleshooting.md).
35
-
4.**Customize the library information**:
36
-
- Open the file `release.properties` and edit the `name`, `authors`, and `sentence` fields to match your library.
37
-
- Rerun the `deployToProcessingSketchbook` Gradle task to update the library information.
38
-
- Open the Contribution Manager again to see your changes. The name, description, and author(s) should be updated.
24
+
1.**Open up your new repository in your chosen IDE.**
25
+
2.**Run the Gradle task `deployToProcessingSketchbook`:**
26
+
*In the Gradle menu (the elephant icon) in your IDE, navigate to `Tasks` > `processing` >
27
+
`deployToProcessingSketchbook`, and double-click on `deployToProcessingSketchbook`.
28
+
* This will build the library, create the release artifacts, and copy them to the folder
29
+
where Processing libraries are stored.
30
+
3.**Check if the library appears as a contributed library:**
31
+
* Open Processing, and click on `Sketch` > `Import Library ...`.
32
+
* You should see an entry named "A Template Example Library" in the menu as `Contributed`.
33
+
This is the sample library you just installed using the template.
34
+
* If it does not appear, please check the [troubleshooting guide](troubleshooting.md).
35
+
39
36
40
37
## Next Steps
41
38
Great, now that you're familiar with the library template, you can explore additional guides:
0 commit comments