46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
# Compiled License
|
|
|
|
*A fork of [elorest's library](https://github.com/elorest/compiled_license).*
|
|
|
|
Compiles the licences of all shards used in project into binary.
|
|
This allows you to legally distribute binaries without having to package the licenses files from the shards.
|
|
|
|
## Installation
|
|
|
|
Add this to your application's `shard.yml`:
|
|
|
|
```yaml
|
|
dependencies:
|
|
compiled_license:
|
|
git: https://git.dergrimm.net/dergrimm/compiled_license.git
|
|
```
|
|
|
|
## Usage
|
|
|
|
```crystal
|
|
require "compiled_license"
|
|
|
|
puts CompiledLicense::LICENSES
|
|
```
|
|
|
|
Compile and run
|
|
|
|
```
|
|
$ crystal build src/testapp.cr
|
|
$ testapp
|
|
# Returns all licenses to stdout
|
|
```
|
|
|
|
## Contributing
|
|
|
|
1. Fork it ( https://github.com/grimmigerFuchs/compiled_license/fork )
|
|
2. Create your feature branch (git checkout -b my-new-feature)
|
|
3. Commit your changes (git commit -am 'Add some feature')
|
|
4. Push to the branch (git push origin my-new-feature)
|
|
5. Create a new Pull Request
|
|
|
|
## Contributors
|
|
|
|
- [elorest](https://github.com/elorest) Isaac Sloan - creator, maintainer
|
|
- [grimmigerFuchs](https://git.dergrimm.net/dergrimm) - contributor
|