Skip to content

Commit c03968c

Browse files
authored
fix doc errors (#79)
* rename releaseProcessingLib to buildReleaseArtifacts * correct nested lists; remove last step in getting started
1 parent 3708a28 commit c03968c

File tree

2 files changed

+17
-20
lines changed

2 files changed

+17
-20
lines changed

docs/develop.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,16 +105,16 @@ already run Gradle tasks, and edited the `release.properties` file.
105105
library, toggle `Tasks` > `processing` and double click `writeLibraryProperties`. This task will
106106
copy all the values in `release.properties`, and also include the `version` in your `build.gradle.kts`
107107
file as `prettyVersion`.
108-
2. **To build the library and create the release artifacts, run the Gradle task `releaseProcessingLib`.**
108+
2. **To build the library and create the release artifacts, run the Gradle task `buildReleaseArtifacts`.**
109109
This task will create a `release` folder with needed artifacts. To do this, go to the Gradle menu
110-
(elephant), toggle `Tasks` > `processing` and double click `releaseProcessingLib`. This task
110+
(elephant), toggle `Tasks` > `processing` and double click `buildReleaseArtifacts`. This task
111111
has bundled the following required tasks:
112112
1. `build` task: this bundles a number of build tasks, including the `jar` task which creates a
113113
jar file. all build artifacts are in the folder `build`.
114114
2. documentation build.
115115
3. creation of the `library.properties` file: this file is built from the properties set in the
116116
`release.properties` file, plus the version, in the task `writeLibraryProperties`.
117-
4. within the `releaseProcessingLib` task, the `release` folder is created, jars of the library and
117+
4. within the `buildReleaseArtifacts` task, the `release` folder is created, jars of the library and
118118
dependencies are copied, and the `library.properties` file is copied. Also, a zip file is made.
119119
3. When you would like to test your library in Processing, toggle `Tasks` > `processing` and double click
120120
`deployToProcessingSketchbook`, which will create the release artifacts, and copy them into the

docs/getting-started.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# 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.
33

44
This guide will help you set up your development environment and start building your library using the provided template.
55

66

77
## Setting up the environment
88
Follow these steps to create your own repository on GitHub and install the necessary tools.
99

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)
1111
as a base.
1212
(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))
1313
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
2121
## Testing the Library Template
2222
Now that your environment is set up, follow these steps to get familiar with the template and make sure everything works correctly:
2323

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+
3936

4037
## Next Steps
4138
Great, now that you're familiar with the library template, you can explore additional guides:

0 commit comments

Comments
 (0)