rust-embedded / book

Documentation on how to use the Rust Programming Language to develop firmware for bare metal (microcontroller) devices
https://docs.rust-embedded.org/book/
Apache License 2.0
1.08k stars 173 forks source link

How would one cite this book in an academic resource? #327

Closed cvvletter closed 1 year ago

cvvletter commented 2 years ago

See title, preferably in biblatex style.

cvvletter commented 2 years ago

This is what I came up with:

@book{embedded-rust,
  title = {The Embedded Rust Book},
  author = {},
  date = {},
  url = {https://docs.rust-embedded.org/book/},
  urldate = {2022-08-26},
}

Maybe the author would be 'Rust on Embedded Devices Working Group', but what could I put as date or the likes?

adamgreig commented 2 years ago

That seems OK. I probably would just leave a date accessed, the same as you might for a URL, or the date of the most recent commit when you viewed it. For author, "Rust Embedded Working Group & Contributors" or something like that would be fine.

cvvletter commented 2 years ago

Thank you. I changed it to the following:

@book{embedded-rust,
  title = {The Embedded Rust Book},
  author = {{Rust on Embedded Devices Working Group} and others},
  date = {}, % intentionally left empty
  url = {https://docs.rust-embedded.org/book/},
  urldate = {2022-08-26},
}

which is correctly handled (in IEEE format) as: Rust on Embedded Devices Working Group et al., The Embedded Rust Book. [Online]. Available: https://docs.rust-embedded.org/book (visited on 26/08/2022).

Would it be useful if I add the preferred citation at the end of the Introduction in a pull request?

adamgreig commented 2 years ago

Looks good. Maybe the best way to add it to the repository would be via GitHub's built-in support for citations:

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

Ideally you'd write a CFF file with the same info, and then GitHub can parse it and render it to a bibtex or other formats depending on what people want. It looks like you could also just stick a CITATION.bib file in the repo root and it will at least offer 'Cite this repository' as an option, though without parsing or converting the file.

cvvletter commented 1 year ago

I chose to only PR the .bib file, due to the .cff file not supporting "et al." nor empty date fields. Feel free to let me know your thoughts.