Skip to content

Commit a42568b

Browse files
authored
Update README.md
1 parent ca86056 commit a42568b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ These instructions will help you get started with developing a library for Proce
1111
The following components must be installed in order to go through the Usage Instructions.
1212

1313
* [Gradle Build Tool](https://gradle.org/) (use version 7.x, this library template is not compatible with Gradle 8+ yet).
14-
* Latest LTS release of the [Adoptium OpenJDK](https://adoptium.net/).
14+
* Version 17 of LTS release of the [Adoptium OpenJDK](https://adoptium.net/) (21-LTS or newer not yet supported).
1515
* [Git client](https://git-scm.com/downloads).
1616
* [Android Studio](https://developer.android.com/studio/) version 3.1 or later.
1717
* [Processing 4.2](https://processing.org/download/) or later.
@@ -27,18 +27,20 @@ The following components must be installed in order to go through the Usage Inst
2727
* Change the repository name to the name of your library and save your changes.
2828
* NOTE: GitHub only allows you to fork a project once. If you need to create multiple forks, you can follow these [instructions](http://adrianshort.org/2011/11/08/create-multiple-forks-of-a-github-repo/).
2929
3. Checkout your fork of the template repository using your preferred git client.
30-
4. You can test if the template project can be built with Gradle by open a command line terminal, changing the directory to the processing inside the repository location, and calling ```gradle dist```. This should generarate a distribution folder with several files in it, including ```YourLibrary.zip```. If this is the case, then you are ready to start working with the template to create your own library.
31-
5. Edit the resources/build.properties file to ensure the following fields are set correctly.
30+
4. You can test if the template project can be built with Gradle by open a command line terminal, changing the directory to the ```processing``` subdirectory inside the repository location, and calling ```gradle dist```. This should generarate a distribution folder with several files in it, including ```YourLibrary.zip```. If this is the case, then you are ready to start working with the template to create your own library.
31+
5. Edit the ```processing/resources/build.properties``` file to ensure the following fields are set correctly.
3232
* **sketchbook.location** is a quasi-optional field that should be set to the path of your Processing sketchbook folder. This field tells the Gradle build to deploy the library to the sketchbook/libraries path defined here (in addition to building a .zip distribution).
3333
* **android_sdk.location** should contain the path to the Android SDK in your computer. If you have used the Android mode before and let it to automatically download the SDK for you, then it will be inside the sketchbook/android/sdk folder, but here you can set any other location.
3434
* All of the fields in sections (4) and on are for metadata about your library.
35-
6. Also, make sure to edit the library medatata in resources/library.properties file.
35+
6. Also, make sure to edit the library medatata in ```processing/resources/library.properties``` file.
3636

3737
After having compiled and built your project successfully, you should be able to find your library in Processing's sketchbook folder, examples will be listed in Processing's sketchbook menu. The Gradle build process also generates a zip package of your library for distribution.
3838

3939
## Import into Android Studio
4040

4141
1. Open Android Studio and select the "Import project" menu item in the welcome screen.
42-
2. Navigate to the location where you checked out the repository in your computer, and select the debug folder.
43-
3. Android Studio should be able to import the debug project automatically, which includes the library itself and a minimal test app.
42+
2. Navigate to the location where you checked out the repository in your computer, and select the root folder (not the ```processing``` subfolder).
43+
3. Android Studio should be able to import the project automatically, which includes the library itself and a minimal test app.
44+
45+
Note that the source code of the library is located inside ```library/src``` to follow standard Gradle's project structure. If you make changes there during the debugging using Android Studio, and then use the compilation and packaging instructions above, the resulting library package will include your latest changes in the source code made in Android Studio.
4446

0 commit comments

Comments
 (0)