MakiAi commited on
Commit
b5b8e49
1 Parent(s): 73ba87d

✨ feat: CLIとPyPIインストール方法の追加、ドキュメント改善

Browse files

- PyPIからのインストール方法を追加しました。これにより、ユーザーは簡単にパッケージをインストールできます。
- ソースからのインストール手順を明確化しました。
- コマンドラインインターフェース(CLI)の使い方を追加し、使用方法をより詳細に説明しました。
- 各セクションの見出しを改善し、全体的な可読性を向上させました。
- 画像処理の機能概要を簡潔に記述しました。

Files changed (1) hide show
  1. README.md +30 -3
README.md CHANGED
@@ -7,7 +7,6 @@ colorFrom: blue
7
  colorTo: purple
8
  pinned: false
9
  app_file: pic_to_header/app.py
10
-
11
  ---
12
 
13
  <div align="center">
@@ -36,9 +35,20 @@ Pic-to-Headerは、マスク画像と入力画像を使用してヘッダー画
36
  - マスク画像と入力画像をアップロード
37
  - 入力画像にマスクを適用してヘッダー画像を生成
38
  - 生成されたヘッダー画像のプレビューとダウンロード
 
39
 
40
  ## 🛠️ インストール
41
 
 
 
 
 
 
 
 
 
 
 
42
  1. リポジトリをクローンします:
43
 
44
  ```
@@ -46,14 +56,16 @@ git clone https://github.com/Sunwood-ai-labs/pic-to-header.git
46
  cd pic-to-header
47
  ```
48
 
49
- 2. 必要な依存関係をインストールします:
50
 
51
  ```
52
- pip install -r requirements.txt
53
  ```
54
 
55
  ## 📖 使用方法
56
 
 
 
57
  1. Streamlitアプリケーションを起動します:
58
 
59
  ```
@@ -68,10 +80,25 @@ streamlit run pic_to_header/app.py
68
 
69
  5. 生成されたヘッダー画像をプレビューし、必要に応じてダウンロードします。
70
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
  ## 💻 開発
72
 
73
  - `pic_to_header/core.py`: 画像処理の主要な機能を含みます。
74
  - `pic_to_header/app.py`: Streamlitを使用したWebインターフェースを提供します。
 
75
 
76
  ## 📄 ライセンス
77
 
 
7
  colorTo: purple
8
  pinned: false
9
  app_file: pic_to_header/app.py
 
10
  ---
11
 
12
  <div align="center">
 
35
  - マスク画像と入力画像をアップロード
36
  - 入力画像にマスクを適用してヘッダー画像を生成
37
  - 生成されたヘッダー画像のプレビューとダウンロード
38
+ - コマンドラインインターフェース (CLI) を使用した画像処理
39
 
40
  ## 🛠️ インストール
41
 
42
+ ### 方法1: PyPIからのインストール
43
+
44
+ Pic-to-Headerは、PyPIで利用可能です。以下のコマンドでインストールできます:
45
+
46
+ ```
47
+ pip install pic-to-header
48
+ ```
49
+
50
+ ### 方法2: ソースからのインストール
51
+
52
  1. リポジトリをクローンします:
53
 
54
  ```
 
56
  cd pic-to-header
57
  ```
58
 
59
+ 2. パッケージをインストールします:
60
 
61
  ```
62
+ pip install -e .
63
  ```
64
 
65
  ## 📖 使用方法
66
 
67
+ ### Streamlitウェブアプリケーション
68
+
69
  1. Streamlitアプリケーションを起動します:
70
 
71
  ```
 
80
 
81
  5. 生成されたヘッダー画像をプレビューし、必要に応じてダウンロードします。
82
 
83
+ ### コマンドラインインターフェース (CLI)
84
+
85
+ CLIを使用して画像を処理することもできます:
86
+
87
+ ```
88
+ pic-to-header input_image.png mask_image.png output_image.png
89
+ ```
90
+
91
+ 例:
92
+
93
+ ```
94
+ pic-to-header assets/sample.png assets/mask.png output_image.png
95
+ ```
96
+
97
  ## 💻 開発
98
 
99
  - `pic_to_header/core.py`: 画像処理の主要な機能を含みます。
100
  - `pic_to_header/app.py`: Streamlitを使用したWebインターフェースを提供します。
101
+ - `pic_to_header/cli.py`: コマンドラインインターフェースを提供します。
102
 
103
  ## 📄 ライセンス
104