@@ -85,21 +85,6 @@ if (rsp != NULL) {
85
85
}
86
86
```
87
87
88
- ## Keeping up to date with note-c repo
89
-
90
- This library depends on the Blues [ ` note-c ` library] [ note-c ] . To update this
91
- repo with the latest from ` note-c ` , run the ` update_note_c.sh ` shell script
92
- from the ` scripts/ ` folder:
93
-
94
- ``` none
95
- scripts/update_note_c.sh
96
- ```
97
-
98
- _ ** NOTE:** It is important to use the script. It utilizes git subtrees to
99
- include the appropriate files in the ` src/note-c ` folder. It also eliminates
100
- folders that necessary for testing ` note-c ` individually, but interfere with
101
- the Arduino build environment._
102
-
103
88
## Documentation
104
89
105
90
The documentation for this library can be found
@@ -260,7 +245,22 @@ at the end of the array, and syntax should be as follows,
260
245
261
246
## Generating a Release
262
247
263
- ### Update Files
248
+ ### Update ` note-c ` dependency
249
+
250
+ This library depends on the Blues [ ` note-c ` library] [ note-c ] . To update this
251
+ repo with the latest from ` note-c ` , run the ` update_note_c.sh ` shell script
252
+ from the ` scripts/ ` folder:
253
+
254
+ ``` none
255
+ scripts/update_note_c.sh
256
+ ```
257
+
258
+ _ ** NOTE:** It is important to use the script. It utilizes git subtrees to
259
+ include the appropriate files in the ` src/note-c ` folder. It also eliminates
260
+ folders that necessary for testing ` note-c ` individually, but interfere with
261
+ the Arduino build environment._
262
+
263
+ ### Update Version Files
264
264
265
265
When generating a release of the ` note-arduino ` library, you will need to update
266
266
the version in two places.
@@ -281,12 +281,13 @@ the version in two places.
281
281
version string should follow the form "\< major\> .\< minor\> .\< patch\> " (e.g.
282
282
` 1.6.4 ` ). This value will be used by the Arduino Library Manager.
283
283
284
- ### GitHub Release
284
+ ### Arduino Library Manager Release
285
285
286
286
Publishing a release on GitHub will trigger the Arduino Library Manager. The
287
- Arduino Library Manager will then look to the ` library.properties ` file, and
288
- generate a release based on the ` version ` value it finds there. It should be
289
- noted, the version on GitHub is not evaluated by the Arduino Library Manager.
287
+ Arduino Library Manager will look to the ` library.properties ` file, and generate
288
+ a release based solely on the ` version ` value it finds there.
289
+
290
+ _ ** NOTE:** The GitHub version is not evaluated by the Arduino Library Manager._
290
291
291
292
## More Information
292
293
0 commit comments