diff --git a/.zenodo.json b/.zenodo.json new file mode 100644 index 0000000..335f117 --- /dev/null +++ b/.zenodo.json @@ -0,0 +1,21 @@ +{ + "creators": [{"name": "devkyato", "affiliation": "MATA Company"}], + "contributors": [{"name": "Cursor Agent", "type": "Other"}], + "title": "Arduino Programs Guide: safety-first compile-checked Arduino Uno course", + "description": "Arduino Programs Guide is a progressive, safety-first Arduino Uno course covering serial commands, LED patterns, PWM motor control, state machines, and emergency-stop behaviour. Each lesson pairs a compile-checked sketch with wiring, safety, test, and extension guidance. Usage: follow the lessons in order, build the documented circuits safely, compile and upload the sketches, and complete each verification checklist. Applications include classroom instruction, introductory embedded systems labs, supervised motor-control exercises, and independent Arduino study.", + "version": "1.0.1", + "keywords": ["Arduino", "education", "course", "Uno", "safety", "PWM", "motor control", "embedded", "serial"], + "license": "mit", + "upload_type": "software", + "access_right": "open", + "language": "eng", + "related_identifiers": [ + {"identifier": "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/devkyato/Arduino-Programs-Guide", "relation": "isSupplementTo", "resource_type": "software"}, + {"identifier": "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/devkyato/Datary", "relation": "references", "resource_type": "software"}, + {"identifier": "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/devkyato/OpenNet", "relation": "references", "resource_type": "software"}, + {"identifier": "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/devkyato/TapAuth", "relation": "references", "resource_type": "software"}, + {"identifier": "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/devkyato/Lowpack", "relation": "references", "resource_type": "software"}, + {"identifier": "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/devkyato/Relay", "relation": "references", "resource_type": "software"}, + {"identifier": "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/devkyato/Custom-Arduino-Libraries", "relation": "references", "resource_type": "software"} + ] +} diff --git a/CHANGELOG.md b/CHANGELOG.md index 1fdf8e2..b50bc40 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## [1.0.1] - 2026-08-09 + +- Add Zenodo and Citation File Format metadata for archival citation. +- Refresh course publication and citation guidance. + ## [1.0.0] - 2026-07-29 - Turn the sketch collection into a six-lesson learning path. @@ -8,3 +13,4 @@ - Add official Arduino Uno compilation checks and contributor templates. [1.0.0]: https://github.com/devkyato/Arduino-Programs-Guide/releases/tag/v1.0.0 +[1.0.1]: https://github.com/devkyato/Arduino-Programs-Guide/compare/v1.0.0...v1.0.1 diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..bc86901 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,19 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it using the metadata from this file." +title: "Arduino Programs Guide: safety-first compile-checked Arduino Uno course" +authors: + - family-names: devkyato + affiliation: "MATA Company" +version: 1.0.1 +license: MIT +repository-code: "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/devkyato/Arduino-Programs-Guide" +url: "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/devkyato/Arduino-Programs-Guide" +abstract: "A safety-first compile-checked Arduino Uno course." +keywords: [Arduino, education, course, Uno, safety, PWM, motor control, embedded, serial] +preferred-citation: + type: software + title: "Arduino Programs Guide: safety-first compile-checked Arduino Uno course" + authors: + - family-names: devkyato + affiliation: "MATA Company" + version: 1.0.1 diff --git a/README.md b/README.md index 76b92c9..6b8a15d 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,23 @@ every sketch with the official Arduino toolchain. Other boards may use different PWM pins, voltage levels, serial ports, or ADC ranges; porting notes are welcome only when verified on hardware. +## Citation + +If you use this software in research or teaching, please cite the Zenodo archive / this repository: + +```text +devkyato. (2026). Arduino Programs Guide: safety-first compile-checked Arduino Uno course (Version 1.0.1). +``` + +See [CITATION.cff](CITATION.cff) for machine-readable metadata. + +## Applications + +- Introductory Arduino Uno coursework. +- Safety-first PWM motor-control lessons. +- Compile-checked embedded systems laboratories. +- Independent practice with serial, state machines, and digital outputs. + ## Contributing Student contributions are encouraged. Good changes include clearer diagrams, diff --git a/VERSION b/VERSION index 3eefcb9..7dea76e 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1