Merge pull request #3 from AJpon/docs

Add README

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 pon
+
+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.

README.md

@@ -1,7 +1,40 @@
 # UPM_LocalPackageManager
+## 概要
+Local package manager(以下LPM)は、Unity Package Manager(UPM)でローカルパッケージパスの記録方式を変更するパッケージです。
 
-## Install
-Install via UPM  
+UPMでローカルパッケージを追加すると、パッケージのパスが`manifest.json`に記録されます。通常は絶対パスが記録されますが、`manifest.json`を直接変更することで相対パスを使用することもできます。  
+しかし、パスの記録方式の変更や確認は手作業で行う必要がありました。
+
+LPMはUPMでローカルパッケージを追加するときに、パスの記録方式を選択できるようにします。  
+また、UPMで選択した追加済みローカルパッケージの記録パスをGUIで確認、変更できるようにします。
+
+![image](./Imgs/overview.gif)
+
+## 要件
+Unity 2022.3.0f1 以上
+
+## インストール
+UPMを使用してインストールします。
 ```
 https://github.com/AJpon/UPM_LocalPackageManager.git
 ```
+
+1. `Window` > `Package Manager` を開きます。
+2. `+` > `Add package from git URL...` を選択します。
+3. ```https://github.com/AJpon/UPM_LocalPackageManager.git``` を入力し、`Add` を押すことで最新版がインストールされます。
+
+## 使い方
+UPM上でパッケージを選択し、`Open LPM`を押すとLPMが開きます。ローカルパッケージの追加時には自動で開きます。  
+LPMでは`manifest.json`の`dependencies`に記録されたパスの形式をGUIで確認、変更できます。  
+`Open manifest.json`を押すとUnityで設定したデフォルトのエディタで`manifest.json`を開きます。
+
+![image](./Imgs/lpm.gif)
+
+## 注意事項
+- LPMは`manifest.json`の`dependencies`に記録されたパスの形式を変更するだけで、パッケージのインストールやアンインストールは行いません。
+- 相対パスで示せない場所にインストールされたパッケージは、相対パスに変更することはできません。その場合、絶対パスを使用します。
+    - ドライブパスが異なる場合などが該当します。
+
+## License
+[MIT License](./LICENSE)  
+Copyright (c) 2023 pon