https://github.com/songmu/gocredits

creates CREDITS file from LICENSE files of dependencies
https://github.com/songmu/gocredits

Last synced: 6 days ago
JSON representation

creates CREDITS file from LICENSE files of dependencies

• Host: GitHub
• URL: https://github.com/songmu/gocredits
• Owner: Songmu
• License: mit
• Created: 2019-04-09T14:49:44.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-06T05:37:05.000Z (4 months ago)
• Last Synced: 2024-10-11T21:09:23.684Z (27 days ago)
• Language: Go
• Homepage:
• Size: 42 KB
• Stars: 110
• Watchers: 3
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
gocredits

=======

[![Test Status](https://github.com/Songmu/gocredits/workflows/test/badge.svg?branch=main)][actions]

[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]

[![PkgGoDev](https://pkg.go.dev/badge/github.com/Songmu/gocredits)][PkgGoDev]

[actions]: https://github.com/Songmu/gocredits/actions?workflow=test

[license]: https://github.com/Songmu/gocredits/blob/main/LICENSE

[PkgGoDev]: https://pkg.go.dev/github.com/Songmu/gocredits

gocredits creates CREDITS file from LICENSE files of dependencies

## Synopsis

```console

gocredits . > CREDITS

```

## Description

When distributing built executable in Go, we need to include LICENSE of the dependent

libraries into the package, so gocredits bundle them together as a CREDITS file.

To use `gocredits`, we should use go modules for dependency management.

## Installation

### homebrew

```console

% brew install Songmu/tap/gocredits

```

### go get

```console

% go install github.com/Songmu/gocredits/cmd/gocredits@latest

```

### [aqua](https://aquaproj.github.io/)

```console

% aqua g -i Songmu/gocredits

```

Built binaries are available on GitHub Releases.

## Author

[Songmu](https://github.com/Songmu)