はじめに
Windows向けにEXEを配布するとき、アプリ本体だけを用意しても配布物としては不十分です。
利用者には、起動方法、削除方法、設定の戻し方、SmartScreen警告への注意、開発元情報が必要です。さらに、外部ライブラリを使っている場合はライセンス表記も欠かせません。
毎回ゼロからREADMEやチェックリストを作ると抜け漏れが出やすいため、配布用ドキュメントの型を持っておくと便利です。
こんな場面で使えます
- 個人開発ツールをブログやGitHub Releasesで配布する
- PyInstallerでPythonアプリをEXE化する
- インストーラーなしのZIP配布にする
- 外部ライブラリのライセンス表記を整理したい
- リリース直前の確認漏れを減らしたい
実装パターン
READMEに入れる項目
配布ZIP内の README.txt は、利用者がすぐ使うための説明にします。
1. ツール概要
2. 同梱ファイル説明
3. 使い始め方
4. タスクバーやショートカットでの運用
5. 初期ショートカットや主要機能
6. 設定変更、設定の読み込み、設定の書き出し
7. 終了方法
8. アンインストール方法
9. SmartScreenやウイルス対策ソフト警告の注意
10. 開発元、GitHub、解説ブログ
11. バージョン
GitHubのREADMEは開発者向けに詳しく書くことがありますが、配布ZIP内のREADMEは短く、利用者向けにします。
LICENSEとTHIRD_PARTY_NOTICES
自作部分のライセンスは LICENSE.txt に明示します。外部ライブラリは THIRD_PARTY_NOTICES.txt に分けると読みやすくなります。
Package / Version / Purpose / License / Project URL
Python標準ライブラリだけでなく、同梱されるライブラリやツールのライセンスも確認対象です。
配布前チェックリスト
配布直前に確認する項目をテキストで残しておきます。
[ ] EXEが入っている
[ ] config.jsonが公開用設定になっている
[ ] 個人パス・秘密情報が含まれていない
[ ] READMEが入っている
[ ] LICENSEが入っている
[ ] THIRD_PARTY_NOTICESが入っている
[ ] 別フォルダで起動確認した
[ ] ZIPファイル名にバージョンを入れた
設計のポイント
| ドキュメント | 目的 |
|---|---|
| README.txt | 利用者が導入、起動、削除できるようにする |
| LICENSE.txt | 自作部分の利用条件を明示する |
| THIRD_PARTY_NOTICES.txt | 外部ライブラリのライセンス表記を分離する |
| 配布前チェックリスト.txt | リリース前の抜け漏れを防ぐ |
注意点・ハマりポイント
- ライセンス判断は公式情報を確認する: ライブラリのライセンスは変わることがあるため、配布直前に公式情報を確認します。
- 別フォルダで起動確認する: 開発フォルダでは動くのに、配布フォルダでは依存ファイル不足で動かないことがあります。
- READMEは利用者目線で書く: 開発手順や内部構造より、起動、終了、削除、トラブル時の対応を優先します。
- SmartScreen警告に触れる: 個人配布のEXEでは警告が出る場合があります。利用者が戸惑わないよう、READMEに注意を書きます。
実際の活用事例
Windows向けのPython製小型ツールをZIP配布する際、README、LICENSE、THIRD_PARTY_NOTICES、配布前チェックリストを分けました。利用者向け説明と開発者向けREADMEを分けたことで、配布物としての見通しが良くなりました。
まとめ
- EXE配布では、アプリ本体だけでなく説明書とライセンス表記が必要
- READMEは利用者向けに短く、起動と削除まで書く
- 外部ライブラリは
THIRD_PARTY_NOTICESに分ける - 配布直前はチェックリストで機密情報、同梱漏れ、別フォルダ起動を確認する