From 7ecb39f453a591e487454e02eb82533a6b19f994 Mon Sep 17 00:00:00 2001 From: "@dev.mako" <95612413+devkyato@users.noreply.github.com> Date: Sun, 9 Aug 2026 00:36:38 +0800 Subject: [PATCH] release: ArduinoPatterns 1.0.1 Zenodo archival metadata Add citation metadata, applications/discovery documentation, and bump to 1.0.1 for Zenodo-oriented publication. Co-authored-by: Cursor --- .zenodo.json | 21 +++++++++++++++++++++ CHANGELOG.md | 8 ++++++++ CITATION.cff | 19 +++++++++++++++++++ README.md | 19 ++++++++++++++++++- library.json | 2 +- library.properties | 2 +- 6 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 .zenodo.json create mode 100644 CITATION.cff diff --git a/.zenodo.json b/.zenodo.json new file mode 100644 index 0000000..fd3d058 --- /dev/null +++ b/.zenodo.json @@ -0,0 +1,21 @@ +{ + "creators": [{"name": "devkyato", "affiliation": "MATA Company"}], + "contributors": [{"name": "Cursor Agent", "type": "Other"}], + "title": "ArduinoPatterns: non-blocking LED and digital-output patterns for Arduino", + "description": "ArduinoPatterns is a small teaching library for coordinating LEDs and other digital outputs without delay(). It provides rollover-safe millis()-based patterns, output banks, and periodic outputs with no heap allocation or board-specific API. Usage: install the library in Arduino IDE or PlatformIO, include ArduinoPatterns.h, and update patterns from loop(). Applications include Arduino lessons, traffic-light demonstrations, ESP32 and RP2040 sketches, responsive user interfaces, and embedded output control.", + "version": "1.0.1", + "keywords": ["Arduino", "LED", "non-blocking", "millis", "library", "education", "ESP32", "RP2040"], + "license": "mit", + "upload_type": "software", + "access_right": "open", + "language": "eng", + "related_identifiers": [ + {"identifier": "https://github.com/devkyato/Custom-Arduino-Libraries", "relation": "isSupplementTo", "resource_type": "software"}, + {"identifier": "https://github.com/devkyato/Datary", "relation": "references", "resource_type": "software"}, + {"identifier": "https://github.com/devkyato/OpenNet", "relation": "references", "resource_type": "software"}, + {"identifier": "https://github.com/devkyato/TapAuth", "relation": "references", "resource_type": "software"}, + {"identifier": "https://github.com/devkyato/Lowpack", "relation": "references", "resource_type": "software"}, + {"identifier": "https://github.com/devkyato/Relay", "relation": "references", "resource_type": "software"}, + {"identifier": "https://github.com/devkyato/Arduino-Programs-Guide", "relation": "references", "resource_type": "software"} + ] +} diff --git a/CHANGELOG.md b/CHANGELOG.md index 43fd3ca..741b03a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to ArduinoPatterns are documented here. The project follows [Semantic Versioning](https://semver.org/). +## [1.0.1] - 2026-08-09 + +### Changed + +- Add Zenodo and Citation File Format metadata for archival citation. +- Refresh published Arduino library metadata for the 1.0.1 release. + ## [1.0.0] - 2026-07-29 ### Added @@ -15,3 +22,4 @@ All notable changes to ArduinoPatterns are documented here. The project follows - Arduino IDE ZIP and PlatformIO installation metadata. [1.0.0]: https://github.com/devkyato/Custom-Arduino-Libraries/releases/tag/v1.0.0 +[1.0.1]: https://github.com/devkyato/Custom-Arduino-Libraries/compare/v1.0.0...v1.0.1 diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..5f97877 --- /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: "ArduinoPatterns: non-blocking LED and digital-output patterns for Arduino" +authors: + - family-names: devkyato + affiliation: "MATA Company" +version: 1.0.1 +license: MIT +repository-code: "https://github.com/devkyato/Custom-Arduino-Libraries" +url: "https://github.com/devkyato/Custom-Arduino-Libraries" +abstract: "Non-blocking LED and digital-output patterns for Arduino." +keywords: [Arduino, LED, non-blocking, millis, library, education, ESP32, RP2040] +preferred-citation: + type: software + title: "ArduinoPatterns: non-blocking LED and digital-output patterns for Arduino" + authors: + - family-names: devkyato + affiliation: "MATA Company" + version: 1.0.1 diff --git a/README.md b/README.md index 34c919d..645c29a 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Library** in Arduino IDE. In PlatformIO: ```ini lib_deps = - https://github.com/devkyato/Custom-Arduino-Libraries.git#v1.0.0 + https://github.com/devkyato/Custom-Arduino-Libraries.git#v1.0.1 ``` ## Quick example @@ -67,6 +67,23 @@ arithmetic. CI compiles for Arduino AVR Uno, ESP32, and RP2040. Other Arduino architectures are expected to work but should be reported as verified only after an actual compile or hardware test. +## Citation + +If you use this software in research or teaching, please cite the Zenodo archive / this repository: + +```text +devkyato. (2026). ArduinoPatterns: non-blocking LED and digital-output patterns for Arduino (Version 1.0.1). +``` + +See [CITATION.cff](CITATION.cff) for machine-readable metadata. + +## Applications + +- Non-blocking LED and traffic-light demonstrations. +- Arduino timing and state-machine lessons. +- Responsive ESP32 and RP2040 digital-output sketches. +- Reusable output patterns alongside sensors and serial communication. + ## Contributing Student-friendly issues are labeled `good first issue`. Changes should remain diff --git a/library.json b/library.json index 9c2acdb..5018208 100644 --- a/library.json +++ b/library.json @@ -1,6 +1,6 @@ { "name": "ArduinoPatterns", - "version": "1.0.0", + "version": "1.0.1", "description": "Non-blocking LED and digital-output patterns for Arduino.", "keywords": ["arduino", "led", "non-blocking", "millis", "education"], "repository": { diff --git a/library.properties b/library.properties index 7e4e7bb..e6c489b 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoPatterns -version=1.0.0 +version=1.0.1 author=devkyato and contributors maintainer=devkyato sentence=Non-blocking LED and digital-output patterns for Arduino.