bashスクリプト：「Acknowledge」

「Acknowledge」のGitHubページにあるREADMEの私家版和訳です。

別途インストールした「MultiMarkdown-6」に対して、謝辞ファイルを生成させるbashスクリプトの様です。

因みにMultiMarkdown-6は、macOSだけでなく、Windowsにも対応してる様なので、このbashスクリプトを写経すれば、VisualStudio等向けのスクリプトが出来るんじゃないかな？

以下、本文です。

0. 概要

Acknowledgeはシンプルなbashスクリプトで、iOSやOSXプロジェクトで使用したライブラリ、フレームワーク、その他のコードに対するすべての謝辞を含むrtfを、簡単に生成します。

Acknowledgeは、DCOAboutWindowとCocoapodsとの相性が抜群です。Fletcher Penny製MultiMarkdownに依存しています。

1. セットアップ

1.1. GitHubからクローン

このリポジトリをクローンして、できればXcodeプロジェクトのルートに置いてください：

$ git clone git@github.com:DangerCove/Acknowledge.git

あるいは、プロジェクトがすでにリポジトリである場合は、サブモジュールとして追加してください：

$ git submodule add git@github.com:DangerCove/Acknowledge.git

1.2. multimarkdownをインストール

フレッチャーのサイトのガイドに従うか、homebrewを使用している場合：

$ brew install multimarkdown

1.3. 設定

acknowledge.cfg.defaultをacknowledge.cfgにコピーします：

$ cd Acknowledge
$ cp acknowledge.cfg.default acknowledge.cfg

必要に応じて、multimarkdown及びPodsフォルダへのパスをカスタマイズします。

1.4. Acknowledgmentsの追加

1.4.1. Cocoapods

Cocoapodsを使っていてPodsディレクトリが設定されていれば、準備は完了です。ただ、acknowledgeを実行するだけです。

$ ./acknowledge

1.4.2. Other acknowledgments

markdownファイルをsourcesディレクトリに追加するだけで、Acknowledgeが残りの部分を処理します。拡張子が.mdであることを確認してください。

1.4.3. 順番

sourcesフォルダ内のファイル名に10_や20_という接頭辞がついていることに気がついたかもしれません。Acknowledgeはファイルを順番に連結するので、ファイルを追加して番号を変更するだけで、順番を変更できます。

Cocoapodsが生成した謝辞ファイル名には、常に10_が付加されます。

1.5. ディレクトリ・レイアウト例

.
|- Acknowledge/
|   |- acknowledge
|   |- ...
|   |- source/
|   |   |- 11_Vendor.md
|   |   |- 20_Acknowledge.md
|- Pods/
|   |- Pods-acknowledgements.markdown
|-  |- ...
|- Podfile
|- Coolproject.xcodeproj
|- Coolproject.xcworkspace
|- ...

1.6. テスト

このステップをスキップしない様に。次のステップで出力する必要があります。

ターミナルウィンドウを開いてacknowledgeを一度実行し、動作するかどうかを確認し、最初のAcknowledgments.rtfを生成します。

$ ./acknowledge

エラーがあれば修正して、次に進みます。

1.7. Xcodeに追加

1.7.1. プロジェクトへの、謝辞ファイル追加

アプリ内のどこかに謝辞を表示したいと思うことでしょう（ところで。Macアプリで取り組んでる場合はDCOAboutWindowを見てください）。

生成されたファイルAcknowledgments.rtfをプロジェクトに追加して、どこかに表示するだけです。

1.7.2. ビルドごとに謝辞ファイル生成

Acknowledgeをビルドフェーズとして追加すれば、謝辞を最新の状態に保つのは簡単です。その仕組みは以下の通りです：

1. Xcodeを開く；

2. プロジェクトを選択してBuild Phasesタブを開く；

3. メニュー「エディタ→ビルドフェーズの追加→Runスクリプトの追加」をクリックする；

4. Runスクリプトに「Update Acknowledgments」のような名前をつけ、Copy Bundle Resourcesの上に配置する；

5. ここで以下のコードを追加する：

cd Acknowledge && ./acknowledge

（スクリプトがデフォルトのフォルダにない場合は、パスを調整してください。）

こんな感じになるはずです：

それだけ！　プロジェクトをビルドするだけで準備完了です。

2. 貢献、そして機能の追加

創造的であること。Acknowledgeは、柔軟で、謝辞ファイル生成の容易な方法でなければなりません。正当な理由なく、既存の機能を損なっていないことを確認してください。

3. ライセンス

MITライセンス、詳細はLICENSEファイルを参照してください。