argmaxinc / WhisperKit

On-device Speech Recognition for Apple Silicon
http://argmaxinc.com/blog/whisperkit
MIT License
3.92k stars 331 forks source link

Create CITATION.CFF #22

Closed ezefranca closed 8 months ago

ezefranca commented 9 months ago

This PR adds the citation file: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.

I also encourage you to create a DOI using Zenodo. https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content

ZachNagengast commented 9 months ago

Hi @ezefranca thanks for this submission. We do have a bibtex in our readme so perhaps this should follow that format, what do you think? Also curious, do you have a specific use case for this i.e. are you hoping to cite the repo?

For reference here is our current bibtex:

@misc{whisperkit-argmax,
   title = {WhisperKit},
   author = {Argmax, Inc.},
   year = {2024},
   URL = {https://github.com/argmaxinc/WhisperKit}
}
ZachNagengast commented 8 months ago

@ezefranca closing this for now till we hear back from you, can reopen it with any edits needed.