iris-s-coon commited on
Commit
128da6f
1 Parent(s): 460065c

📖 [docs] 英語READMEの更新

Browse files
Files changed (1) hide show
  1. docs/README.en.md +38 -35
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.