Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/cats-oss/acknowledgementsplist

AcknowledgementsPlist manages the licenses of libraries that depend on your iOS app.
https://github.com/cats-oss/acknowledgementsplist

acknowledgements cli cocoapods command-line license license-generator license-management plist settings swift swift5 swiftpm xcode

Last synced: 2 days ago
JSON representation

AcknowledgementsPlist manages the licenses of libraries that depend on your iOS app.

Host: GitHub
URL: https://github.com/cats-oss/acknowledgementsplist
Owner: cats-oss
License: mit
Created: 2018-09-24T12:41:38.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2019-10-24T06:19:30.000Z (about 5 years ago)
Last Synced: 2024-08-15T19:07:01.375Z (3 months ago)
Topics: acknowledgements, cli, cocoapods, command-line, license, license-generator, license-management, plist, settings, swift, swift5, swiftpm, xcode
Language: Swift
Homepage:
Size: 32.8 MB
Stars: 77
Watchers: 4
Forks: 4
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## What's AcknowledgementsPlist
`AcknowledgementsPlist` that combines licenses of `Carthage`, `CocoaPods`, and `Manual Plist` into `Bundle` and `Plist`.
I implement it so that it will be completed locally!
- [Carthage](https://github.com/Carthage/Carthage)
- [CocoaPods](https://github.com/CocoaPods/CocoaPods)

![Swift](https://img.shields.io/badge/Swift-4.2-orange.svg)
[![Cocoapods](https://img.shields.io/badge/Cocoapods-compatible-brightgreen.svg)](https://img.shields.io/badge/Cocoapods-compatible-brightgreen.svg)
[![Build Status](https://travis-ci.org/cats-oss/AcknowledgementsPlist.svg?branch=master)](https://travis-ci.org/cats-oss/AcknowledgementsPlist)
[![License](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)](http://mit-license.org)

## Requirements
- Xcode 10.2+
- Swift 5+

## How to install
#### CocoaPods
```Ruby
pod 'AcknowledgementsPlist'
```

#### Executable binary from [releases](https://github.com/cats-oss/AcknowledgementsPlist/releases)
Please use executable binary freely in each project!

## How to use AcknowledgementsPlist
**See [Sample](https://github.com/cats-oss/AcknowledgementsPlist/tree/master/Sample), for more details.**
It is recommended to make it like [make-acknowledgements-plist.sh](https://github.com/cats-oss/AcknowledgementsPlist/blob/master/Sample/Scripts/make-acknowledgements-plist.sh).
I think that you can execute it after `Pods` or `Carthage` is updated.

### Usage
```
acknowledgementsplist [PROJECT_ROOT_PATH] [OUTPUT_PATH] [OPTIONS]

e.g. acknowledgementsplist . ./Sample-Acknowledgements.plist --manual-plist-path ./ManualAcknowledgements.plist
```

#### `[PROJECT_ROOT_PATH]`
- Required🔥
- Please specify the project root path as seen from the directory to be executed!

#### `[OUTPUT_PATH]`
- Required🔥
- Please specify the file name of `./~/foo.plist` and the bundle file name of `./~/bar.bundle` that starting from project root!

### [OPTIONS]
#### `--pods-path`
- You can specify a `Pods` file path. The default is to search automatically.

#### `--carthage-checkouts-path`
- You can specify a `Checkouts` file path. The default is to search automatically.

#### `--manual-plist-path`
- You can add and include licenses manually to plist.
- The configuration of plist.↓
```xml

PreferenceSpecifiers

FooterText
Legal Text
Title
Library Name

FooterText
Legal Text
Title
Library Name

```

#### `--exclude-word`
- Exclude URLs that contain the specified word.
- e.g. `--exclude-word "NSObject-Rx RxOptional"`

### Make Plist
1. Check if `Pods` and b `Carthage/Checkouts` exist.
If `Carthage/Checkouts` does not exist, execute the command of `carthage checkout`.

2. Determine the location of the `AcknowledgementsPlist` and the output location of `Plist`.
e.g. `acknowledgementsplist . ./Sample/Resources/Sample-Acknowledgements.plist`

### Make Bundle
1. Please do `1.` of Make Plist.

2. Make bundle and change `Root.plist` to the following configuration.
```xml

PreferenceSpecifiers

Type
PSChildPaneSpecifier
Title
Licenses
File
AcknowledgementLinks

StringsTable
Root

```

3. Determine the location of the `AcknowledgementsPlist` and the output location of `Bundle`.
e.g. `acknowledgementsplist . ./Sample/Resources/Settings.bundle`

## LICENSE
Under the MIT license. See [LICENSE](https://github.com/cats-oss/AcknowledgementsPlist/blob/master/LICENSE) file for details.