Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplified and clarified the setup instructions #51

Merged
merged 1 commit into from
Sep 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 30 additions & 39 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,45 @@
# Getting Started
We are excited that you wish to contribute to the Processing ecosystem.
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.

This template is designed to make that process as simple as possible.

This guide will get you started on your journey, help orient you to the template.
This guide will help you set up your development environment and start building your library using the provided template.


## Setting up the environment
These steps will help you create your own repository on Github, and install necessary software.

1. **Create your own repository on Github, using the repository [processing-library-template](https://github.com/mingness/processing-library-template)**
as a template.
([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))
Select a different name for your repository that represents the library you will build. You can also
rename your repository at a later time.
2. **Clone your new repository,** aka create a local copy of your repository on your computer.
([A guide to cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
3. **Install [Processing](https://processing.org/download)**, if you haven't already.
Follow these steps to create your own repository on GitHub and install the necessary tools.

1. **Create a new Github repository** using the [processing-library-template](https://github.com/mingness/processing-library-template)
as a base.
(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))
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.
2. **Clone your repository** to your local computer.
([How to clone a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
3. **Install [Processing](https://processing.org/download)**, if it's not already installed on your computer.
4. **Install an integrated development editor (IDE)** such as [Intellij](https://www.jetbrains.com/idea/download),
or [Visual Studio Code](https://code.visualstudio.com/), if you haven't already.
Intellij comes fully featured, and has a free community version. Additional features can be added to
Visual Studio Code by installing extensions, such as Gradle for Java, or Language support for Java.
or [Visual Studio Code](https://code.visualstudio.com/).
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.

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

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

## Next Steps
Great, now you should be a little more familiar with the workings of the library template.

Checkout some other guides on
Great, now that you're familiar with the library template, you can explore additional guides:

1. [The development process](develop)
2. [Releasing your library](release)
Expand Down
Loading