https://github.com/matbesancon/cargo-cite
Generate a citation file from Rust projects.
https://github.com/matbesancon/cargo-cite
cargo cargo-subcommand citation rust
Last synced: 12 months ago
JSON representation
Generate a citation file from Rust projects.
- Host: GitHub
- URL: https://github.com/matbesancon/cargo-cite
- Owner: matbesancon
- License: mit
- Created: 2019-05-16T19:42:37.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T21:33:57.000Z (about 2 years ago)
- Last Synced: 2025-03-18T05:22:58.443Z (about 1 year ago)
- Topics: cargo, cargo-subcommand, citation, rust
- Language: Rust
- Size: 12.7 KB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.bib
Awesome Lists containing this project
README
# cargo-cite
## A cargo extension to produce a citable BibTeX from crates
[](https://travis-ci.org/matbesancon/cargo-cite)
## Installation
`cargo-cite` is not registered so you will need the following steps:
```shell
git clone git@github.com:matbesancon/cargo-cite.git
cd cargo-cite
cargo install --path .
```
The command `cargo cite` will then be available.
## Why
Citing software is important to acknowledge the work of others,
but also because academic software development depends on it.
One pain point developers have is to find **how** to cite a given library.
One has to look in the README, documentation or some other file.
A recent experiment in the Julia community is to standardize
citations in one file at the top-level of projects, named `CITATION.bib`
with all the relevant BibTeX entries for the project.
Multiple entries can be added for different sub-topics related to the
software, as you can see in the Julia [repo](https://github.com/JuliaLang/julia/blob/master/CITATION.bib).
## How does cargo-cite help
`cargo-cite` is an experimental Rust crate to generate a
`CITATION.bib` file for a Rust project based on its Cargo.toml file.
It can be yours or someone else's. Once the `CITATION.bib` file is created,
feel free to add other entries to it - for example, a software paper
published in the [Journal of Open-Source Software](http://joss.theoj.org).
## Usage
Say you are using [ndarray](https://github.com/rust-ndarray/ndarray.git)
for your work, but they have not published a CITATION.bib yet:
```
$ git clone https://github.com/rust-ndarray/ndarray.git
$ cd ndarray
$ cargo cite
```
A `CITATION.bib` file has been created. To add the reference to this file
in the README, run:
```
$ cargo cite -r
```
## Available options
See `cargo cite --help` for options.