Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to cite this repository? #138

Closed
TobiasAxelsen opened this issue Nov 21, 2023 · 4 comments
Closed

How to cite this repository? #138

TobiasAxelsen opened this issue Nov 21, 2023 · 4 comments

Comments

@TobiasAxelsen
Copy link

Hello

Throughout my project work I will be having to cite this repository, but I don't find any bibtex or something along those lines. Is there a preferred way that you want to be cited?

@mhubii
Copy link
Member

mhubii commented Nov 21, 2023

That is a very fair question and I very much appreciate that! Let me upload something to arxiv..

@tvercaut
Copy link

tvercaut commented Nov 21, 2023

@mhubii I suggest you also add a JOSS submitted badge on the main README here. You will find the badge used in your JOSS review thread:
openjournals/joss-reviews#5629

Additionally, once the arxiv paper is live, you should add a cff file and a "how to cite" section in the README. We can update from arxiv to JOSS as soon as the JOSS paper is (hopefully) accepted. Doc on cff for github:
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

@mhubii
Copy link
Member

mhubii commented Nov 22, 2023

There is now a citation section in the readme @TobiasAxelsen

@TobiasAxelsen
Copy link
Author

Thank you very much :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants