MakiAi commited on
Commit
3760a38
2 Parent(s): 228eb97 b770706

Merge branch 'main' of https://github.com/Sunwood-ai-labs/pic-to-header

Browse files
Files changed (2) hide show
  1. README.md +31 -13
  2. docs/README.en.md +38 -35
README.md CHANGED
@@ -28,16 +28,19 @@ app_file: pic_to_header/app.py
28
 
29
  </div>
30
 
31
- Pic-to-Headerは、マスク画像と入力画像を使用してヘッダー画像を生成するPythonアプリケーションです。
32
 
33
- ## 🚀 機能
34
 
35
- - マスク画像と入力画像をアップロード
36
- - 入力画像にマスクを適用してヘッダー画像を生成
 
 
 
 
37
  - 生成されたヘッダー画像のプレビューとダウンロード
38
  - コマンドラインインターフェース (CLI) を使用した画像処理
39
 
40
- ## 🛠️ インストール
41
 
42
  ### 方法1: PyPIからのインストール
43
 
@@ -51,10 +54,15 @@ pip install pic-to-header
51
 
52
  1. リポジトリをクローンします:
53
 
54
- ```
55
- git clone https://github.com/Sunwood-ai-labs/pic-to-header.git
56
- cd pic-to-header
57
- ```
 
 
 
 
 
58
 
59
  2. パッケージをインストールします:
60
 
@@ -62,15 +70,25 @@ cd pic-to-header
62
  pip install -e .
63
  ```
64
 
65
- ## 📖 使用方法
 
 
 
 
 
 
 
 
66
 
67
  ### Streamlitウェブアプリケーション
68
 
69
  1. Streamlitアプリケーションを起動します:
70
 
71
- ```
72
- streamlit run pic_to_header/app.py
73
- ```
 
 
74
 
75
  2. ブラウザで表示されるURLにアクセスします。
76
 
 
28
 
29
  </div>
30
 
31
+ Pic-to-Headerは、マスク画像と入力画像を使用してヘッダー画像を生成するPythonアプリケーションです。 バージョン 0.1.0 がリリースされました。
32
 
33
+ ## 🚀 プロジェクト概要
34
 
35
+ Pic-to-Headerは、マスク画像と入力画像を使用して簡単にヘッダー画像を生成し、ダウンロードできるStreamlitアプリケーションです。PyPIにも公開されています。
36
+
37
+ ## ✨ 主な機能
38
+
39
+ - マスク画像と入力画像のアップロード
40
+ - ヘッダー画像の生成
41
  - 生成されたヘッダー画像のプレビューとダウンロード
42
  - コマンドラインインターフェース (CLI) を使用した画像処理
43
 
 
44
 
45
  ### 方法1: PyPIからのインストール
46
 
 
54
 
55
  1. リポジトリをクローンします:
56
 
57
+ 1. **インストール**:
58
+ ```bash
59
+ pip install -r requirements.txt
60
+ ```
61
+ 2. **Streamlit アプリケーションの起動**:
62
+ ```bash
63
+ streamlit run pic_to_header/app.py
64
+ ```
65
+ 3. ブラウザで表示されるURLにアクセスし、入力画像とマスク画像をアップロードして、「ヘッダー画像を生成」ボタンをクリックしてください。
66
 
67
  2. パッケージをインストールします:
68
 
 
70
  pip install -e .
71
  ```
72
 
73
+ 1. リポジトリをクローンします:
74
+ ```bash
75
+ git clone https://github.com/Sunwood-ai-labs/pic-to-header.git
76
+ cd pic-to-header
77
+ ```
78
+ 2. 必要な依存関係をインストールします:
79
+ ```bash
80
+ pip install -r requirements.txt
81
+ ```
82
 
83
  ### Streamlitウェブアプリケーション
84
 
85
  1. Streamlitアプリケーションを起動します:
86
 
87
+ - リポジトリ名が `HarmonAI III` から `Pic-to-Header` に変更されました。
88
+ - READMEにリリース、タグ、PyPIバージョンのバッジを追加しました。
89
+ - PyPIへのパッケージ公開を自動化しました。
90
+ - Streamlitアプリケーションの機能強化とデザイン改善を行いました。
91
+ - 入力サンプル画像、生成サンプル画像、マスク画像を追加しました。
92
 
93
  2. ブラウザで表示されるURLにアクセスします。
94
 
docs/README.en.md CHANGED
@@ -1,7 +1,7 @@
1
  ---
2
- license: MIT
3
  title: Pic-to-Header
4
- sdk: Streamlit
5
  emoji: 🐨
6
  colorFrom: blue
7
  colorTo: purple
@@ -29,52 +29,55 @@ app_file: pic_to_header/app.py
29
 
30
  </div>
31
 
32
- Pic-to-Header is a Python application that generates header images using a mask image and an input image.
33
 
34
- ## 🚀 Features
35
 
36
- - Upload a mask image and an input image.
37
- - Apply the mask to the input image to generate a header image.
38
- - Preview and download the generated header image.
39
 
40
- ## 🛠️ Installation
41
 
42
- 1. Clone the repository:
43
-
44
- ```bash
45
- git clone https://github.com/Sunwood-ai-labs/pic-to-header.git
46
- cd pic-to-header
47
- ```
48
-
49
- 2. Install the required dependencies:
50
 
51
- ```bash
52
- pip install -r requirements.txt
53
- ```
54
 
55
- ## 📖 Usage
56
 
57
- 1. Launch the Streamlit application:
 
 
 
 
 
 
 
 
58
 
59
- ```bash
60
- streamlit run pic_to_header/app.py
61
- ```
62
 
63
- 2. Access the URL displayed in your browser.
64
 
65
- 3. Upload the input image and the mask image.
66
-
67
- 4. Click the "Generate Header Image" button.
68
-
69
- 5. Preview and download the generated header image as needed.
 
 
 
 
70
 
 
71
 
72
- ## 💻 Development
 
 
 
 
73
 
74
- - `pic_to_header/core.py`: Contains the main image processing functions.
75
- - `pic_to_header/app.py`: Provides the web interface using Streamlit.
76
 
77
  ## 📄 License
78
 
79
- This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
80
- ```
 
1
  ---
2
+ license: mit
3
  title: Pic-to-Header
4
+ sdk: streamlit
5
  emoji: 🐨
6
  colorFrom: blue
7
  colorTo: purple
 
29
 
30
  </div>
31
 
32
+ Pic-to-Header is a Python application that generates header images using a mask image and an input image. Version 0.1.0 has been released.
33
 
34
+ ## 🚀 Project Overview
35
 
36
+ Pic-to-Header is a Streamlit application that allows you to easily generate and download header images using a mask image and an input image. It's also available on PyPI.
 
 
37
 
38
+ ## Key Features
39
 
40
+ - Upload mask and input images
41
+ - Generate header images
42
+ - Preview and download generated header images
43
+ - Display README.md (within the Streamlit app)
44
+ - A calming, dark theme
 
 
 
45
 
 
 
 
46
 
47
+ ## 🔧 How to Use
48
 
49
+ 1. **Installation**:
50
+ ```bash
51
+ pip install -r requirements.txt
52
+ ```
53
+ 2. **Run the Streamlit application**:
54
+ ```bash
55
+ streamlit run pic_to-header/app.py
56
+ ```
57
+ 3. Access the URL displayed in your browser, upload your input and mask images, and click the "Generate Header Image" button.
58
 
 
 
 
59
 
60
+ ## 📦 Installation Instructions
61
 
62
+ 1. Clone the repository:
63
+ ```bash
64
+ git clone https://github.com/Sunwood-ai-labs/pic-to-header.git
65
+ cd pic-to-header
66
+ ```
67
+ 2. Install the necessary dependencies:
68
+ ```bash
69
+ pip install -r requirements.txt
70
+ ```
71
 
72
+ ## 🆕 What's New (v0.1.0)
73
 
74
+ - The repository name has been changed from `HarmonAI III` to `Pic-to-Header`.
75
+ - Added release, tag, and PyPI version badges to the README.
76
+ - Automated PyPI package publishing.
77
+ - Enhanced functionality and improved design of the Streamlit application.
78
+ - Added sample input images, generated sample images, and mask images.
79
 
 
 
80
 
81
  ## 📄 License
82
 
83
+ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.