github.com/Songmu/gocredits@v0.3.1-0.20231111084238-af961788d757/README.md (about)

     1  gocredits
     2  =======
     3  
     4  [![Test Status](https://github.com/Songmu/gocredits/workflows/test/badge.svg?branch=main)][actions]
     5  [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]
     6  [![PkgGoDev](https://pkg.go.dev/badge/github.com/Songmu/gocredits)][PkgGoDev]
     7  
     8  [actions]: https://github.com/Songmu/gocredits/actions?workflow=test
     9  [license]: https://github.com/Songmu/gocredits/blob/main/LICENSE
    10  [PkgGoDev]: https://pkg.go.dev/github.com/Songmu/gocredits
    11  
    12  gocredits creates CREDITS file from LICENSE files of dependencies
    13  
    14  ## Synopsis
    15  
    16  ```console
    17  gocredits . > CREDITS
    18  ```
    19  
    20  ## Description
    21  
    22  When distributing built executable in Go, we need to include LICENSE of the dependent
    23  libraries into the package, so gocredits bundle them together as a CREDITS file.
    24  
    25  To use `gocredits`, we should use go modules for dependency management.
    26  
    27  ## Installation
    28  
    29  ### homebrew
    30  
    31  ```console
    32  % brew install Songmu/tap/gocredits
    33  ```
    34  
    35  ### go get
    36  
    37  ```console
    38  % go install github.com/Songmu/gocredits/cmd/gocredits@latest
    39  ```
    40  
    41  ### [aqua](https://aquaproj.github.io/)
    42  
    43  ```console
    44  % aqua g -i Songmu/gocredits
    45  ```
    46  
    47  Built binaries are available on GitHub Releases.
    48  <https://github.com/Songmu/gocredits/releases>
    49  
    50  ## Author
    51  
    52  [Songmu](https://github.com/Songmu)