Skip to content

Commit c3c328c

Browse files
authored
Simplified and clarified the setup instructions (#51)
1 parent 92ac37e commit c3c328c

File tree

1 file changed

+30
-39
lines changed

1 file changed

+30
-39
lines changed

Diff for: docs/getting-started.md

+30-39
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,45 @@
11
# Getting Started
2-
We are excited that you wish to contribute to the Processing ecosystem.
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

4-
This template is designed to make that process as simple as possible.
5-
6-
This guide will get you started on your journey, help orient you to the template.
4+
This guide will help you set up your development environment and start building your library using the provided template.
75

86

97
## Setting up the environment
10-
These steps will help you create your own repository on Github, and install necessary software.
11-
12-
1. **Create your own repository on Github, using the repository [processing-library-template](https://github.com/mingness/processing-library-template)**
13-
as a template.
14-
([A guide to creating a repository from a template.](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template))
15-
Select a different name for your repository that represents the library you will build. You can also
16-
rename your repository at a later time.
17-
2. **Clone your new repository,** aka create a local copy of your repository on your computer.
18-
([A guide to cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
19-
3. **Install [Processing](https://processing.org/download)**, if you haven't already.
8+
Follow these steps to create your own repository on GitHub and install the necessary tools.
9+
10+
1. **Create a new Github repository** using the [processing-library-template](https://github.com/mingness/processing-library-template)
11+
as a base.
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+
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.
14+
2. **Clone your repository** to your local computer.
15+
([How to clone a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
16+
3. **Install [Processing](https://processing.org/download)**, if it's not already installed on your computer.
2017
4. **Install an integrated development editor (IDE)** such as [Intellij](https://www.jetbrains.com/idea/download),
21-
or [Visual Studio Code](https://code.visualstudio.com/), if you haven't already.
22-
Intellij comes fully featured, and has a free community version. Additional features can be added to
23-
Visual Studio Code by installing extensions, such as Gradle for Java, or Language support for Java.
18+
or [Visual Studio Code](https://code.visualstudio.com/).
19+
Intellij comes fully featured, and has a free community version. For Visual Studio Code, you'll need to install additional extensions, such as Gradle for Java and Java language support.
2420

25-
## First steps
26-
These steps use the template as is, to allow you to interact with the build environment, and with Processing.
27-
You can use these interactions to test the library.
21+
## Testing the Library Template
22+
Now that your environment is set up, follow these steps to get familiar with the template and make sure everything works correctly:
2823

2924
1. **Open up your new repository in your chosen IDE.**
30-
2. **Run the Gradle task, deployToProcessingSketchbook**: The repository as is should build in Gradle.
31-
In the Gradle menu (elephant) in your IDE, navigate to `Tasks` > `processing` >
25+
2. **Run the Gradle task `deployToProcessingSketchbook`:**
26+
- In the Gradle menu (the elephant icon) in your IDE, navigate to `Tasks` > `processing` >
3227
`deployToProcessingSketchbook`, and double click on `deployToProcessingSketchbook`.
33-
This will run the Gradle task named `deployToProcessingSketchbook`.
34-
Running this task will build the library, create the release artifacts, and copy them into
35-
where your installed libraries are stored.
36-
3. **The library can now be seen in the Contribution Manager.** Open Processing, and click on
37-
`Sketch` > `Import Library ...` > `Manage Libraries ...`. This opens the Contribution Manager.
38-
There should be an entry named "A Template Example Library" with a check mark next to it.
39-
That is the entry for the example library that was installed in the previous step.
40-
If the library does not appear in the Contribution
41-
Manager, please check the [troubleshooting guide](troubleshooting.md).
42-
4. **Customize what will be shown in the Contribution Manager for your library**:
43-
Open the file `release.properties` and change the value of the fields `name`,
44-
`authors`, and `sentence`. Rerun the Gradle task, `deployToProcessingSketchbook`. This
45-
will reinstall the library with the updated values, and these values should be visible
46-
in the Contribution Manager.
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 in the Contribution Manager:**
31+
- Open Processing, and click on `Sketch` > `Import Library ...` > `Manage Libraries ...`.
32+
This opens the Contribution Manager.
33+
- You should see an entry named "A Template Example Library" with a check mark next to it.
34+
This is the sample library you just installed using the template.
35+
- If it does not appear, please check the [troubleshooting guide](troubleshooting.md).
36+
4. **Customize the library information**:
37+
- Open the file `release.properties` and edit the `name`, `authors`, and `sentence` fields to match your library.
38+
- Rerun the `deployToProcessingSketchbook` Gradle task to update the library information.
39+
- Open the Contribution Manager again to see your changes. The name, description, and author(s) should be updated.
4740

4841
## Next Steps
49-
Great, now you should be a little more familiar with the workings of the library template.
50-
51-
Checkout some other guides on
42+
Great, now that you're familiar with the library template, you can explore additional guides:
5243

5344
1. [The development process](develop)
5445
2. [Releasing your library](release)

0 commit comments

Comments
 (0)