Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/EmbarkStudios/cargo-about

📜 Cargo plugin to generate list of all licenses for a crate 🦀
https://github.com/EmbarkStudios/cargo-about

cargo cargo-plugin hacktoberfest license-checking licensing rust rust-lang spdx

Last synced: 7 days ago
JSON representation

📜 Cargo plugin to generate list of all licenses for a crate 🦀

Host: GitHub
URL: https://github.com/EmbarkStudios/cargo-about
Owner: EmbarkStudios
License: apache-2.0
Created: 2019-11-01T08:38:11.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2024-09-02T16:13:50.000Z (2 months ago)
Last Synced: 2024-10-13T12:01:08.699Z (about 1 month ago)
Topics: cargo, cargo-plugin, hacktoberfest, license-checking, licensing, rust, rust-lang, spdx
Language: Rust
Homepage: http://embark.rs
Size: 5.4 MB
Stars: 532
Watchers: 5
Forks: 32
Open Issues: 23
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

        



# `📜 cargo-about`

**Cargo plugin for generating a license listing for all dependencies of a crate**

[![Embark Opensource](https://img.shields.io/badge/embark-open%20source-blueviolet.svg)](https://embark.dev)

[![Embark Discord](https://img.shields.io/badge/discord-ark-%237289da.svg?logo=discord)](https://discord.gg/Fg4u4VX)

[![Crates.io](https://img.shields.io/crates/v/cargo-about.svg)](https://crates.io/crates/cargo-about)

[![API Docs](https://docs.rs/cargo-about/badge.svg)](https://docs.rs/cargo-about)

[![SPDX Version](https://img.shields.io/badge/SPDX%20Version-3.24.0-blue.svg)](https://spdx.org/licenses/)

[![Minimum Stable Rust Version](https://img.shields.io/badge/Rust-1.74.0-blue?color=fc8d62&logo=rust)](https://github.com/rust-lang/rust/blob/master/RELEASES.md#version-1740-2023-11-16)

[![dependency status](https://deps.rs/repo/github/EmbarkStudios/cargo-about/status.svg)](https://deps.rs/repo/github/EmbarkStudios/cargo-about)

[![Build Status](https://github.com/EmbarkStudios/cargo-about/workflows/CI/badge.svg)](https://github.com/EmbarkStudios/cargo-about/actions?workflow=CI)



See the [book 📕](https://embarkstudios.github.io/cargo-about/) for in-depth documentation.

_Please Note: This is a tool that we use (and like!) and it makes sense to us to release it as open source. However, we can’t take any responsibility for your use of the tool, if it will function correctly or fulfil your needs. No functionality in - or information provided by - cargo-about constitutes legal advice._

## Getting started

### Installing

#### From crates.io

```bash

cargo install --locked cargo-about

```

#### On Arch Linux

```bash

pacman -S cargo-about

```

### Generate license information for your own project

```bash

# Generates `about.toml` and `about.hbs` in your cargo project

cargo about init

# Generate the license information with

cargo about generate about.hbs > license.html

```

## Contributing

[![Contributor Covenant](https://img.shields.io/badge/contributor%20covenant-v1.4-ff69b4.svg)](CODE_OF_CONDUCT.md)

We welcome community contributions to this project.

Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.

## License

Licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )

- MIT license ([LICENSE-MIT](LICENSE-MIT) or )

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.