Skip to content

Enhancing getting-started docs #73

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

Closed
vincentsijben opened this issue Mar 21, 2025 · 5 comments
Closed

Enhancing getting-started docs #73

vincentsijben opened this issue Mar 21, 2025 · 5 comments
Labels
feedback User feedback

Comments

@vincentsijben
Copy link
Contributor

vincentsijben commented Mar 21, 2025

Were you able to successfully create a library with this template? What has been your general experience with this template?

When following https://processing.github.io/processing-library-template/getting-started.html I used the 2 options provided (vscode with 2 extensions and Intellij community edition). Both installations gave me "toolchain" errors, caused by these lines:

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}

and since I'm a total newbie at using the Gradle approach, I couldn't resolve it quickly. Later on, I've found some answers about creating a settings.gradle.kts and add this:

// settings.gradle.kts
plugins {
    id("org.gradle.toolchains.foojay-resolver-convention") version "0.9.0"
}

After doing this everything worked... So, I tried creating a new project, just to test if everything would work again, and this time I didn't create the settings.gradle.kts and it still worked. So somehow... I needed to install that plugin once, where it remembered it being installed...

Maybe that could be added to the step by step guide?


Furthermore: step 12 "Open the Contribution Manager again to see your changes. The name, description, and author(s) should be updated.". Is this correct?
Locally installed libraries aren't shown in the Contribution Manager, only in the list at Sketch - Import Library.
If one would change name, author and sentence, only the name part could be seen in that list. Maybe that point 12 needs to be rephrased?


Step 2 over at https://processing.github.io/processing-library-template/develop mentions "releaseProcessingLib". Couldn't find that one. I guess it has to be "buildReleaseArtifacts" ?

@vincentsijben vincentsijben added the feedback User feedback label Mar 21, 2025
@mingness
Copy link
Collaborator

Thanks for your feedback @vincentsijben. Apologies for the trouble with the toolchain plugin, and thanks for your solution. I will dig more into that issue. Not sure if it's relevant, but can you also provide what operating system you are using?

Thanks for catching the errors in the documentation - the error in the description about the Contribution Manager was know, but somehow that mention was missed, and the other issue was indeed due to a change in the naming of tasks.

@vincentsijben
Copy link
Contributor Author

no problem! I've tested it both on Windows 11 and MacOs Sequoia 15.3.1

@vincentsijben
Copy link
Contributor Author

@mingness side question: My library is already added to the contributed libraries, but I created it with the "ant" approach. My guess is: if I change the process to Gradle, I dont have to use the new "submit issue" way to get it into the contributed list, right? I could just change the internals, and keep on releasing new versions that processing will automatically pick up because i'm alread y in the list, correct?

@mingness
Copy link
Collaborator

@vincentsijben That's right. If all the urls that you initially submitted the library with, meaning, the location of the latest release, and the location of the txt file are still the same, then there's nothing to submit to us.

@mingness mingness mentioned this issue Mar 24, 2025
@mingness
Copy link
Collaborator

All issues raised have been addressed. Will close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feedback User feedback
Projects
None yet
Development

No branches or pull requests

2 participants