diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..e4de6b6 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Ryota Yamafuji (PengentAI) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/docs/tips.md b/docs/tips.md index b74eaff..862a0ac 100644 --- a/docs/tips.md +++ b/docs/tips.md @@ -115,3 +115,63 @@ vscode.commands.registerCommand('imagemarkpengent.openImageEditor', (uri: vscode // ここに画像編集処理 }); ``` + +## デプロイ方法 + +VSCodeの拡張機能(extension)を実装した後、公開して他の人に使ってもらうには、主に以下の方法があります: + +--- + +### ① **Visual Studio Code Marketplace に公開する(公式手順)** + +👉 一般的・標準的な方法。VSCode本体からインストール可能になる。 + +#### 必要な準備 + +1. **Microsoftアカウント** と **Publisherアカウント登録** + +* [Visual Studio Marketplace](https://marketplace.visualstudio.com/manage) で publisher を作成 + +1. **`vsce` CLIツール のインストール** + +#### デプロイを実行する + +```bash +npm install -g vsce +``` + + +#### 公開手順 + +1. **パッケージ作成** + +```bash +vsce package +``` + +`.vsix` ファイルが生成される(ローカル配布にも使える) + +##### リンクエラーになった場合 + +```error + ERROR Couldn't detect the repository where this extension is published. The link './README.jp.md' will be broken in README.md. +``` +vsceが`package.json`に epositoryURLがないため、 +README内のリンク解決ができないというエラーです。 + +GitHubやGitLabにリポジトリがある場合はrepositoryフィールドを入れるとOK。 + + +2. **公開** + + ```bash + vsce publish + ``` + + 初回はアクセストークンが必要(Marketplace から取得)。 + +#### メリット + +* 世界中のユーザーに簡単に配布 +* 自動アップデート対応 + diff --git a/package.json b/package.json index 98a9579..46963b4 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,10 @@ "engines": { "vscode": "^1.99.0" }, + "repository": { + "type": "git", + "url": "https://github.com/pengent-ai/imagemarkpengent.git" + }, "categories": [ "Other" ],