iris-s-coon commited on
Commit
a84ec09
1 Parent(s): 3760a38

📖 [docs] 英語READMEの更新

Browse files
Files changed (1) hide show
  1. docs/README.en.md +52 -12
docs/README.en.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">
@@ -40,24 +39,36 @@ Pic-to-Header is a Streamlit application that allows you to easily generate and
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
@@ -69,15 +80,44 @@ Pic-to-Header is a Streamlit application that allows you to easily generate and
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.
 
7
  colorTo: purple
8
  pinned: false
9
  app_file: pic_to_header/app.py
 
10
  ---
11
 
12
  <div align="center">
 
39
  - Upload mask and input images
40
  - Generate header images
41
  - Preview and download generated header images
42
+ - Image processing using a command-line interface (CLI)
43
+
44
+
45
+ ### Method 1: Installation from PyPI
46
 
47
+ Pic-to-Header is available on PyPI. You can install it using the following command:
48
 
49
+ ```bash
50
+ pip install pic-to-header
51
+ ```
52
 
53
+ ### Method 2: Installation from Source
54
+
55
+ 1. Clone the repository:
56
+
57
+ 2. **Installation:**
58
  ```bash
59
  pip install -r requirements.txt
60
  ```
61
+ 3. **Start the Streamlit application:**
62
  ```bash
63
+ streamlit run pic_to_header/app.py
64
  ```
65
+ 4. Access the URL displayed in your browser, upload your input and mask images, and click the "Generate Header Image" button.
66
 
67
+ 2. Install the package:
68
 
69
+ ```bash
70
+ pip install -e .
71
+ ```
72
 
73
  1. Clone the repository:
74
  ```bash
 
80
  pip install -r requirements.txt
81
  ```
82
 
83
+ ### Streamlit Web Application
84
+
85
+ 1. Start the Streamlit application:
86
 
87
  - The repository name has been changed from `HarmonAI III` to `Pic-to-Header`.
88
  - Added release, tag, and PyPI version badges to the README.
89
+ - Automated publishing to PyPI.
90
  - Enhanced functionality and improved design of the Streamlit application.
91
  - Added sample input images, generated sample images, and mask images.
92
 
93
+ 2. Access the URL displayed in your browser.
94
+
95
+ 3. Upload your input and mask images.
96
+
97
+ 4. Click the "Generate Header Image" button.
98
+
99
+ 5. Preview the generated header image and download it if needed.
100
+
101
+ ### Command-Line Interface (CLI)
102
+
103
+ You can also process images using the CLI:
104
+
105
+ ```bash
106
+ pic-to-header input_image.png mask_image.png output_image.png
107
+ ```
108
+
109
+ Example:
110
+
111
+ ```bash
112
+ pic-to-header assets/sample.png assets/mask.png output_image.png
113
+ ```
114
+
115
+ ## 💻 Development
116
+
117
+ - `pic_to_header/core.py`: Contains the core image processing functionality.
118
+ - `pic_to_header/app.py`: Provides the web interface using Streamlit.
119
+ - `pic_to_header/cli.py`: Provides the command-line interface.
120
 
121
  ## 📄 License
122
 
123
+ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.