Skip to content

Conversation

RealIndrit
Copy link

@RealIndrit RealIndrit commented Dec 3, 2024

Adding support for built in citation features in GitHub.

In this case the citation file only "citates" the software itself and not the actual publishing at arxiv.org, if the actual published paper is preferred citation it can be pretty easily adapted to fulfill that request using the citation
file format
and changing the CITATION.cff file in the root path of the project strucure

Generated citation strings by GitHub citation feature:

BibTeX

@software{Carnelos_MicroFlow_An_Efficient_2024,
author = {Carnelos, Matteo and Pasti, Francesco and Bellotto, Nicola},
license = {MIT},
month = sep,
title = {{MicroFlow: An Efficient Rust-Based Inference Engine for TinyML}},
url = {https://github.com/matteocarnelos},
version = {0.1.3},
year = {2024}
}

APA

Carnelos, M., Pasti, F., & Bellotto, N. (2024). MicroFlow: An Efficient Rust-Based Inference Engine for TinyML (Version 0.1.3) [Computer software]. https://github.com/matteocarnelos

@matteocarnelos
Copy link
Owner

Thanks for the contribution @RealIndrit! I didn't know about this feature.

In this case, I would prefer the paper to be the preferred citation, rather than the software. Therefore, could you please add the preferred-citation section? Thanks!

@matteocarnelos matteocarnelos added the documentation Improvements or additions to documentation label Dec 10, 2024
license: MIT
commit: 600ebca6d457d1484eb4acf71fb2fba7a9baccef
version: 0.1.3
date-released: '2024-09-28' No newline at end of file
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: please add empty new line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants