In 4 day(s), 10 hour(s) and 9 minute(s): eCommons will be migrating to an upgraded instance of the DSpace repository platform in January. During this migration, eCommons will be available for viewing and downloading only from 12:00 p.m. on January 20, 2026, until 9 a.m. on January 29, 2026.

eCommons

 

Readme Template for Software

dc.contributor.authorDietrich, Dianne
dc.contributor.authorMcKee, Lencia
dc.date.accessioned2025-08-13T15:21:01Z
dc.date.available2025-04-07T17:43:24Z
dc.date.available2025-08-13T15:21:01Z
dc.date.issued2025
dc.descriptionThis Readme template: software is shared under a Creative Commons 1.0 Universal Public Domain Dedication (CC0 1.0). Please adapt, use and share as you see fit; attribution is appreciated when re-sharing, but not required. Citation is not required if using the template to document your software. Please cite as: Dietrich, Dianne, McKee, Lencia. (2025) Readme Template for Software. Cornell University eCommons Repository. https://doi.org/10.7298/h85a-qz91
dc.description.abstractA readme file provides information about a dataset, file(s), or software and is intended to help ensure that the files can be correctly interpreted, by yourself at a later date or by others when sharing or publishing data, code, or software. These README templates are provided in multiple formats for your to adapt and use for your data: -.md (markdown, a language for text formatting that can be opened using a markdown editor or as plain text) -.txt (plain text, which can be opened and edited in a text editor; to download you may need to control-click or right-click and save the file) The accompanying guide to writing “readme” style metadata for your code and software can be found here: https://data.research.cornell.edu/data-management/sharing/writing-readmes-for-research-code-software/ Information about markdown can be found here: https://www.markdownguide.org/
dc.identifier.doihttps://doi.org/10.7298/h85a-qz91.2
dc.identifier.urihttps://hdl.handle.net/1813/116816.2
dc.language.isoen_US
dc.provenancenew version includes revised content
dc.relation.hasversionnew version includes revised content
dc.relation.isreferencedbyKozlowski, Wendy. (2025) Readme Template for Data. Cornell University eCommons Repository. https://doi.org/10.7298/mhns-zm71
dc.relation.isreferencedbyurihttps://doi.org/10.7298/mhns-zm71
dc.relation.isreplacedbyhttps://hdl.handle.net/1813/116816.3
dc.relation.replaceshttps://hdl.handle.net/1813/116816
dc.rightsCC0 1.0 Universalen
dc.rights.urihttp://creativecommons.org/publicdomain/zero/1.0/
dc.subjectdata curation
dc.subjectmetadata
dc.subjectdocumentation
dc.subjectsoftware
dc.subjectpreservation
dc.titleReadme Template for Software
dc.typeother

Files

Original bundle
Now showing 1 - 2 of 2
No Thumbnail Available
Name:
AUTHOR_SOFTWARE_READMEtemplate.txt
Size:
4.12 KB
Format:
Plain Text
No Thumbnail Available
Name:
AUTHOR_SOFTWARE_READMEtemplate.md
Size:
4.12 KB
Format:
Unknown data format

Collections

Version History

Now showing 1 - 3 of 3
VersionDateSummary
2025-10-22 12:25:54
New version of the templates include updated formatting.
2*
2025-08-13 11:13:12
new version includes revised content
2025-04-07 13:43:24
* Selected version