Spaces:
Sleeping
Sleeping
iris-s-coon
commited on
Commit
•
9420008
1
Parent(s):
d58c694
📖 [docs] 英語READMEの更新
Browse files- docs/README.en.md +20 -9
docs/README.en.md
CHANGED
@@ -32,7 +32,18 @@ Pic-to-Header is a Python application that generates header images using a mask
|
|
32 |
|
33 |
## 🚀 Project Overview
|
34 |
|
35 |
-
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
36 |
|
37 |
## ✨ Key Features
|
38 |
|
@@ -47,7 +58,7 @@ Pic-to-Header is a Streamlit application that allows you to easily generate and
|
|
47 |
|
48 |
### Method 1: Installation from PyPI
|
49 |
|
50 |
-
Pic-to-Header is available on PyPI.
|
51 |
|
52 |
```bash
|
53 |
pip install pic-to-header
|
@@ -67,14 +78,14 @@ pip install pic-to-header
|
|
67 |
|
68 |
### Streamlit Web Application
|
69 |
|
70 |
-
1.
|
71 |
```bash
|
72 |
streamlit run pic_to_header/app.py
|
73 |
```
|
74 |
2. Access the URL displayed in your browser.
|
75 |
-
3. Upload
|
76 |
4. Click the "Generate Header Image" button.
|
77 |
-
5. Preview
|
78 |
|
79 |
|
80 |
### Command-Line Interface (CLI)
|
@@ -91,7 +102,7 @@ Example:
|
|
91 |
pic-to-header assets/sample.png assets/mask.png output_image.png
|
92 |
```
|
93 |
|
94 |
-
### Using
|
95 |
|
96 |
The `pic-to-header` package can also be used directly within a Python script. Here's an example:
|
97 |
|
@@ -120,7 +131,7 @@ Running this script will generate the header image at the specified output path.
|
|
120 |
|
121 |
## 💻 Development
|
122 |
|
123 |
-
- `pic_to_header/core.py`: Contains the
|
124 |
- `pic_to_header/app.py`: Provides the web interface using Streamlit.
|
125 |
- `pic_to_header/cli.py`: Provides the command-line interface.
|
126 |
|
@@ -134,8 +145,8 @@ See the "Usage" section above.
|
|
134 |
|
135 |
- Implemented a command-line interface (CLI) for image processing from the command line.
|
136 |
- Added a README page and release notes page to the Streamlit app.
|
137 |
-
- Improved documentation,
|
138 |
-
-
|
139 |
- Version number updated from 0.1.0 to 0.1.1.
|
140 |
|
141 |
|
|
|
32 |
|
33 |
## 🚀 Project Overview
|
34 |
|
35 |
+
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. It also supports a command-line interface (CLI).
|
36 |
+
|
37 |
+
|
38 |
+
## 🎥 Demo Video
|
39 |
+
|
40 |
+
https://github.com/user-attachments/assets/9306ad92-9a2e-45d7-9004-0eba9c0e1207
|
41 |
+
|
42 |
+
|
43 |
+
## 🤗 Demo Site
|
44 |
+
|
45 |
+
<!-- Spacesのステータスバッジ -->
|
46 |
+
[![Spaces](https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg)](https://huggingface.co/spaces/MakiAi/pic-to-header)
|
47 |
|
48 |
## ✨ Key Features
|
49 |
|
|
|
58 |
|
59 |
### Method 1: Installation from PyPI
|
60 |
|
61 |
+
Pic-to-Header is available on PyPI. You can install it using the following command:
|
62 |
|
63 |
```bash
|
64 |
pip install pic-to-header
|
|
|
78 |
|
79 |
### Streamlit Web Application
|
80 |
|
81 |
+
1. Launch the Streamlit application:
|
82 |
```bash
|
83 |
streamlit run pic_to_header/app.py
|
84 |
```
|
85 |
2. Access the URL displayed in your browser.
|
86 |
+
3. Upload the input and mask images.
|
87 |
4. Click the "Generate Header Image" button.
|
88 |
+
5. Preview the generated header image and download it if needed.
|
89 |
|
90 |
|
91 |
### Command-Line Interface (CLI)
|
|
|
102 |
pic-to-header assets/sample.png assets/mask.png output_image.png
|
103 |
```
|
104 |
|
105 |
+
### Using in a Python Script
|
106 |
|
107 |
The `pic-to-header` package can also be used directly within a Python script. Here's an example:
|
108 |
|
|
|
131 |
|
132 |
## 💻 Development
|
133 |
|
134 |
+
- `pic_to_header/core.py`: Contains the main image processing functions.
|
135 |
- `pic_to_header/app.py`: Provides the web interface using Streamlit.
|
136 |
- `pic_to_header/cli.py`: Provides the command-line interface.
|
137 |
|
|
|
145 |
|
146 |
- Implemented a command-line interface (CLI) for image processing from the command line.
|
147 |
- Added a README page and release notes page to the Streamlit app.
|
148 |
+
- Improved documentation, including how to install from PyPI and how to use the CLI.
|
149 |
+
- The CLI entry point changed from `pic_to_header.app:main` to `pic_to_header.cli:main`.
|
150 |
- Version number updated from 0.1.0 to 0.1.1.
|
151 |
|
152 |
|