hyperfine icon indicating copy to clipboard operation
hyperfine copied to clipboard

Add citing guide, as per issue #566

Open jake-87 opened this issue 2 years ago • 5 comments

jake-87 avatar Sep 14 '22 01:09 jake-87

Thank you!

I just found out that there is a new answer on the stackexchange post that I referenced in the other linked issue: https://academia.stackexchange.com/a/172780

It turns out GitHub actually has builtin support for this. Would it be too much to ask to convert this README section into a CITATION.cff file (https://citation-file-format.github.io/)?

sharkdp avatar Sep 14 '22 06:09 sharkdp

My orcid is https://orcid.org/0000-0001-7950-9915

sharkdp avatar Sep 14 '22 06:09 sharkdp

Just found this generator (https://citation-file-format.github.io/cff-initializer-javascript/#/), so here we go:

cff-version: 1.2.0
title: hyperfine
message: >-
  If you use this software in scientific
  publications, please consider citing it using the
  metadata from this file.
type: software
authors:
  - given-names: David
    family-names: Peter
    email: [email protected]
    orcid: 'https://orcid.org/0000-0001-7950-9915'
repository-code: 'https://github.com/sharkdp/hyperfine'
abstract: A command-line benchmarking tool.
license: MIT
version: 1.15.0
date-released: '2022-09-07'

sharkdp avatar Sep 14 '22 06:09 sharkdp

Thanks! Fixed.

jake-87 avatar Sep 15 '22 04:09 jake-87

That should provide all information needed to cite hyperfine.

jake-87 avatar Sep 15 '22 04:09 jake-87