Skip to content

Commit 98fb309

Browse files
committed
Deploying to gh-pages from @ 76400b4 🚀
1 parent df634c2 commit 98fb309

File tree

10 files changed

+126
-75
lines changed

10 files changed

+126
-75
lines changed

404.html

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313

1414
<link rel="icon" href="/processing-library-template/assets/images/favicon.png">
15-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.9">
15+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
1616

1717

1818

@@ -103,11 +103,13 @@
103103

104104

105105

106-
<label class="md-header__button md-icon" for="__search">
107-
108-
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
109-
</label>
110-
<div class="md-search" data-md-component="search" role="dialog">
106+
107+
108+
<label class="md-header__button md-icon" for="__search">
109+
110+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
111+
</label>
112+
<div class="md-search" data-md-component="search" role="dialog">
111113
<label class="md-search__overlay" for="__search"></label>
112114
<div class="md-search__inner" role="search">
113115
<form class="md-search__form" name="search">
@@ -146,6 +148,7 @@
146148
</div>
147149
</div>
148150
</div>
151+
149152

150153

151154
</nav>
@@ -194,6 +197,7 @@
194197
<a href="/processing-library-template/index.html" class="md-nav__link">
195198

196199

200+
197201
<span class="md-ellipsis">
198202
Home
199203

@@ -215,6 +219,7 @@
215219
<a href="/processing-library-template/getting-started.html" class="md-nav__link">
216220

217221

222+
218223
<span class="md-ellipsis">
219224
Get Started
220225

@@ -236,6 +241,7 @@
236241
<a href="/processing-library-template/develop.html" class="md-nav__link">
237242

238243

244+
239245
<span class="md-ellipsis">
240246
Develop
241247

@@ -257,6 +263,7 @@
257263
<a href="/processing-library-template/release.html" class="md-nav__link">
258264

259265

266+
260267
<span class="md-ellipsis">
261268
Release
262269

@@ -278,6 +285,7 @@
278285
<a href="/processing-library-template/troubleshooting.html" class="md-nav__link">
279286

280287

288+
281289
<span class="md-ellipsis">
282290
Troubleshooting
283291

@@ -364,7 +372,9 @@ <h1>404 - Not found</h1>
364372
</div>
365373

366374

367-
<script id="__config" type="application/json">{"base": "/processing-library-template/", "features": ["search.suggest", "search.highlight", "search.share", "content.code.copy", "content.code.select", "content.code.highlight", "content.code.annotate", "navigation.top", "navigation.footer"], "search": "/processing-library-template/assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
375+
376+
377+
<script id="__config" type="application/json">{"base": "/processing-library-template/", "features": ["search.suggest", "search.highlight", "search.share", "content.code.copy", "content.code.select", "content.code.highlight", "content.code.annotate", "navigation.top", "navigation.footer"], "search": "/processing-library-template/assets/javascripts/workers/search.f8cc74c7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
368378

369379

370380
<script src="/processing-library-template/assets/javascripts/bundle.c8b220af.min.js"></script>

develop.html

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919

2020
<link rel="icon" href="assets/images/favicon.png">
21-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.9">
21+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
2222

2323

2424

@@ -114,11 +114,13 @@
114114

115115

116116

117-
<label class="md-header__button md-icon" for="__search">
118-
119-
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
120-
</label>
121-
<div class="md-search" data-md-component="search" role="dialog">
117+
118+
119+
<label class="md-header__button md-icon" for="__search">
120+
121+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
122+
</label>
123+
<div class="md-search" data-md-component="search" role="dialog">
122124
<label class="md-search__overlay" for="__search"></label>
123125
<div class="md-search__inner" role="search">
124126
<form class="md-search__form" name="search">
@@ -157,6 +159,7 @@
157159
</div>
158160
</div>
159161
</div>
162+
160163

161164

162165
</nav>
@@ -205,6 +208,7 @@
205208
<a href="index.html" class="md-nav__link">
206209

207210

211+
208212
<span class="md-ellipsis">
209213
Home
210214

@@ -226,6 +230,7 @@
226230
<a href="getting-started.html" class="md-nav__link">
227231

228232

233+
229234
<span class="md-ellipsis">
230235
Get Started
231236

@@ -256,6 +261,7 @@
256261
<label class="md-nav__link md-nav__link--active" for="__toc">
257262

258263

264+
259265
<span class="md-ellipsis">
260266
Develop
261267

@@ -268,6 +274,7 @@
268274
<a href="develop.html" class="md-nav__link md-nav__link--active">
269275

270276

277+
271278
<span class="md-ellipsis">
272279
Develop
273280

@@ -363,6 +370,7 @@
363370
<a href="release.html" class="md-nav__link">
364371

365372

373+
366374
<span class="md-ellipsis">
367375
Release
368376

@@ -384,6 +392,7 @@
384392
<a href="troubleshooting.html" class="md-nav__link">
385393

386394

395+
387396
<span class="md-ellipsis">
388397
Troubleshooting
389398

@@ -560,41 +569,21 @@ <h2 id="configuring-the-gradle-build-file">Configuring the Gradle build file</h2
560569
contributed library Processing, after being installed. Please look at our
561570
<a href="troubleshooting.html">troubleshooting guide</a> if you suspect this is the case.</p>
562571
</li>
563-
<li>
564-
<p><strong>Define the <code>version</code> of your library in <code>build.gradle.kts</code>.</strong> This value will also be
565-
included in the release artifact <code>library.properties</code>. The version of your library usually
566-
follows semantic versioning (semver), which uses three numbers separated by dots:
567-
"MAJOR.MINOR.PATCH" (e.g., "1.0.0"). </p>
568-
<ul>
569-
<li>MAJOR: Increases when you make incompatible changes.</li>
570-
<li>MINOR: Increases when you add new features that are backward-compatible.</li>
571-
<li>PATCH: Increases when you make backward-compatible bug fixes.</li>
572-
</ul>
573-
<p>You will update these numbers as you release new versions of your library.</p>
574-
</li>
575572
</ol>
576-
<div class="admonition note">
577-
<p class="admonition-title">Note</p>
578-
<p>If you <a href="https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository">release your library on Github</a>,
579-
the prettyVersion field in your release artifacts will reflect your release tag instead of the <code>version</code> defined in <code>build.gradle.kts</code>, as a helpful automation.</p>
580-
</div>
581573
<h2 id="creating-examples">Creating examples</h2>
582574
<p>Examples help users understand your library’s functionality, it is recommended that you include several clear and well-commented samples sketches in the <code>examples</code> folder.</p>
583575
<div class="admonition note">
584576
<p class="admonition-title">Note</p>
585577
<p>The example sketch included in this template outputs the image shown on the home page.</p>
586578
</div>
587579
<h2 id="creating-the-release-artifacts">Creating the release artifacts</h2>
588-
<p>If you've already gone through the <a href="getting-started.html#first-steps">Getting started</a> guide, you will have
589-
already run Gradle tasks, and edited the <code>release.properties</code> file.</p>
590580
<ol>
591-
<li>Fill in the file <code>release.properties</code> with information for your library. This information will be
592-
used by Gradle to create the <code>library.properties</code> file, which is one of the required release
593-
artifacts, used by the website and Contribution Manager to describe your library. In the file itself,
594-
There are comments to guide you. To create just the <code>library.properties</code> file without building the
581+
<li>Fill in the file <code>release.properties</code> with information for your library. In the file itself,
582+
There are comments to guide you. This information will be used by Gradle to create the
583+
<code>library.properties</code> file, which is one of the required release artifacts, used by the website
584+
and Contribution Manager to describe your library. To create just the <code>library.properties</code> file without building the
595585
library, toggle <code>Tasks</code> &gt; <code>processing</code> and double click <code>writeLibraryProperties</code>. This task will
596-
copy all the values in <code>release.properties</code>, and also include the <code>version</code> in your <code>build.gradle.kts</code>
597-
file as <code>prettyVersion</code>.</li>
586+
copy all the values in <code>release.properties</code>.</li>
598587
<li><strong>To build the library and create the release artifacts, run the Gradle task <code>buildReleaseArtifacts</code>.</strong>
599588
This task will create a <code>release</code> folder with needed artifacts. To do this, go to the Gradle menu
600589
(elephant), toggle <code>Tasks</code> &gt; <code>processing</code> and double click <code>buildReleaseArtifacts</code>. This task
@@ -612,6 +601,12 @@ <h2 id="creating-the-release-artifacts">Creating the release artifacts</h2>
612601
<code>deployToProcessingSketchbook</code>, which will create the release artifacts, and copy them into the
613602
sketchbook folder.</li>
614603
</ol>
604+
<div class="admonition note">
605+
<p class="admonition-title">Note</p>
606+
</div>
607+
<p>If you <a href="https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository">release your library on Github</a>,
608+
your release tag will be used for the value of the <code>prettyVersion</code> field, overwriting the value for <code>prettyVersion</code>
609+
defined in <code>release.properties</code>, as a helpful automation.</p>
615610
<h2 id="additional-documentation">Additional Documentation</h2>
616611
<p>See the following guides for more details:</p>
617612
<ul>
@@ -715,7 +710,9 @@ <h2 id="additional-documentation">Additional Documentation</h2>
715710
</div>
716711

717712

718-
<script id="__config" type="application/json">{"base": ".", "features": ["search.suggest", "search.highlight", "search.share", "content.code.copy", "content.code.select", "content.code.highlight", "content.code.annotate", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
713+
714+
715+
<script id="__config" type="application/json">{"base": ".", "features": ["search.suggest", "search.highlight", "search.share", "content.code.copy", "content.code.select", "content.code.highlight", "content.code.annotate", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.f8cc74c7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
719716

720717

721718
<script src="assets/javascripts/bundle.c8b220af.min.js"></script>

getting-started.html

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919

2020
<link rel="icon" href="assets/images/favicon.png">
21-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.9">
21+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
2222

2323

2424

@@ -114,11 +114,13 @@
114114

115115

116116

117-
<label class="md-header__button md-icon" for="__search">
118-
119-
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
120-
</label>
121-
<div class="md-search" data-md-component="search" role="dialog">
117+
118+
119+
<label class="md-header__button md-icon" for="__search">
120+
121+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
122+
</label>
123+
<div class="md-search" data-md-component="search" role="dialog">
122124
<label class="md-search__overlay" for="__search"></label>
123125
<div class="md-search__inner" role="search">
124126
<form class="md-search__form" name="search">
@@ -157,6 +159,7 @@
157159
</div>
158160
</div>
159161
</div>
162+
160163

161164

162165
</nav>
@@ -205,6 +208,7 @@
205208
<a href="index.html" class="md-nav__link">
206209

207210

211+
208212
<span class="md-ellipsis">
209213
Home
210214

@@ -235,6 +239,7 @@
235239
<label class="md-nav__link md-nav__link--active" for="__toc">
236240

237241

242+
238243
<span class="md-ellipsis">
239244
Get Started
240245

@@ -247,6 +252,7 @@
247252
<a href="getting-started.html" class="md-nav__link md-nav__link--active">
248253

249254

255+
250256
<span class="md-ellipsis">
251257
Get Started
252258

@@ -315,6 +321,7 @@
315321
<a href="develop.html" class="md-nav__link">
316322

317323

324+
318325
<span class="md-ellipsis">
319326
Develop
320327

@@ -336,6 +343,7 @@
336343
<a href="release.html" class="md-nav__link">
337344

338345

346+
339347
<span class="md-ellipsis">
340348
Release
341349

@@ -357,6 +365,7 @@
357365
<a href="troubleshooting.html" class="md-nav__link">
358366

359367

368+
360369
<span class="md-ellipsis">
361370
Troubleshooting
362371

@@ -576,7 +585,9 @@ <h2 id="next-steps">Next Steps</h2>
576585
</div>
577586

578587

579-
<script id="__config" type="application/json">{"base": ".", "features": ["search.suggest", "search.highlight", "search.share", "content.code.copy", "content.code.select", "content.code.highlight", "content.code.annotate", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
588+
589+
590+
<script id="__config" type="application/json">{"base": ".", "features": ["search.suggest", "search.highlight", "search.share", "content.code.copy", "content.code.select", "content.code.highlight", "content.code.annotate", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.f8cc74c7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
580591

581592

582593
<script src="assets/javascripts/bundle.c8b220af.min.js"></script>

0 commit comments

Comments
 (0)