Skip to content

Commit 70100e6

Browse files
Update citation format to match Vivarium style
- Use APA-style citation: Author. (Year). Title (Version) [Computer software]. URL - Update CITATION.cff with full descriptive title - Update AUTHORS.md citation section - Update .zenodo.json title - Consistent formatting across all citation files
1 parent f54fdd0 commit 70100e6

File tree

4 files changed

+17
-9
lines changed

4 files changed

+17
-9
lines changed

.zenodo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"title": "On-Body Haptics: Open-Source Wearable Haptic Feedback Systems",
2+
"title": "On-Body Haptics: Open-Source Wearable Haptic Feedback Systems (Version 2.0.0)",
33
"description": "Open-source wearable haptic feedback systems for spatial audio, VR/AR, and interactive installations. Provides complete hardware designs (PCBs, enclosures, BOM), firmware, and software for building custom haptic feedback systems that respond to OSC (Open Sound Control) messages. Includes two complete implementations: Arduino + Bluetooth for portable systems, and Raspberry Pi + I2C for high-fidelity effects.",
44
"license": "MIT",
55
"upload_type": "software",

AUTHORS.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,16 @@ If you use this project in your research, please consider:
6363

6464
If you use this project in academic work, please cite:
6565

66+
MissCrispenCakes. (2024). On-Body Haptics: Open-Source Wearable Haptic Feedback Systems (Version 2.0.0) [Computer software]. https://github.com/MissCrispenCakes/On-body-haptics
67+
68+
**BibTeX:**
6669
```bibtex
6770
@software{onbodyhaptics2024,
71+
author = {MissCrispenCakes},
6872
title = {On-Body Haptics: Open-Source Wearable Haptic Feedback Systems},
69-
author = {Your Name},
73+
version = {2.0.0},
7074
year = {2024},
71-
url = {https://github.com/MissCrispenCakes/On-body-haptics},
72-
version = {2.0.0}
75+
url = {https://github.com/MissCrispenCakes/On-body-haptics}
7376
}
7477
```
7578

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Visit https://bit.ly/cffinit to generate yours today!
33

44
cff-version: 1.2.0
5-
title: On-Body Haptics
5+
title: 'On-Body Haptics: Open-Source Wearable Haptic Feedback Systems'
66
message: >-
77
If you use this software, please cite it using the
88
metadata from this file.

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,19 +227,24 @@ Your support helps maintain and improve this open-source project!
227227

228228
If you use this project in your research, please cite using the information in [CITATION.cff](CITATION.cff) or:
229229

230+
**Suggested Citation:**
231+
232+
MissCrispenCakes. (2024). On-Body Haptics: Open-Source Wearable Haptic Feedback Systems (Version 2.0.0) [Computer software]. https://github.com/MissCrispenCakes/On-body-haptics
233+
234+
**BibTeX:**
230235
```bibtex
231236
@software{onbodyhaptics2024,
232-
title = {On-Body Haptics: Open-Source Wearable Haptic Feedback Systems},
233237
author = {MissCrispenCakes},
238+
title = {On-Body Haptics: Open-Source Wearable Haptic Feedback Systems},
239+
version = {2.0.0},
234240
year = {2024},
235-
url = {https://github.com/MissCrispenCakes/On-body-haptics},
236-
version = {2.0.0}
241+
url = {https://github.com/MissCrispenCakes/On-body-haptics}
237242
}
238243
```
239244

240245
**Zenodo DOI**: Coming soon (archive and get DOI by connecting this repo to Zenodo)
241246

242-
See [AUTHORS.md](AUTHORS.md) for contributor information.
247+
See [CITATION.cff](CITATION.cff) for machine-readable citation metadata and [AUTHORS.md](AUTHORS.md) for contributor information.
243248

244249
---
245250

0 commit comments

Comments
 (0)