search

Breakthrough / PySceneDetect

:movie_camera: Python and OpenCV-based scene cut/transition detection program & library.
https://www.scenedetect.com/
BSD 3-Clause "New" or "Revised" License
3.16k stars 387 forks source link

CITATION.cff file for citing repository #399

Closed a-darcher closed 3 months ago

a-darcher commented 3 months ago

Use Case

I use PySceneDetect as part of an on-going research project and want to cite it in a paper. I haven't found a preferred citation anywhere (hopefully have not missed something obvious). It might be useful to add a CITATION.cff file to the root directory to take advantage of the "Cite this repository" feature of GitHub repos (see here).

Proposed Implementation:

GitHub has a fill-in form/tool available here.

Examples:

A possible example CITATION.cff file might be something like:

cff-version: 1.2.0
authors:
  - family-names: Castellano
    given-names: Brandon
title: "PySceneDetect"
version: 0.6.3
type: software
repository-code: 'https://github.com/Breakthrough/PySceneDetect/'
date-released: 2024-03-98
Breakthrough commented 3 months ago

Thanks for the suggestion, done.