Skip to content

Commit c01375f

Browse files
Update README.md
1 parent ccfa0ab commit c01375f

File tree

1 file changed

+24
-32
lines changed

1 file changed

+24
-32
lines changed

README.md

Lines changed: 24 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -54,48 +54,34 @@ Suppose you have a folder named `/home/USER/ImageCompressor/test/input` that con
5454
The script will compress all the images in the `/home/USER/ImageCompressor/test/input` folder and save the compressed images to the `/home/USER/ImageCompressor/test/output` folder, using a quality factor of 30. Once the compression is complete, a message will be displayed indicating that the process is completed.
5555
## Graphical Interface (User Friendly)
5656
57-
//TODO
58-
### Requirements
59-
- Python 3.x
60-
- PIL Library
61-
62-
### Usage
63-
64-
## Installation Guide
65-
## Windows
66-
Download and install the desired version of Python from the official website:https://www.python.org/downloads/
67-
68-
Open a terminal and run the following command to install PIL:
69-
70-
```
71-
pip install Pillow
72-
```
57+
### Installation Guide
58+
#### Windows
7359
Download the latest release executable of Image Compressor from
7460
https://github.com/github/ImageCompressor-AnyFileExtension-Console-GraphicInterface/releases/tag/v1.0.
7561
7662
Double click on the "ImageCompressor.exe" executable file to run Image Compressor.
7763
78-
79-
## Linux (Debian and Ubuntu)
80-
Download and install the desired version of Python:
81-
82-
```
83-
sudo apt-get update
84-
sudo apt-get install python3
85-
```
86-
87-
Run the following command to install PIL:
88-
```
89-
pip install Pillow
90-
```
91-
64+
#### Linux
9265
Download the latest release executable of Image Compressor from
9366
https://github.com/github/ImageCompressor-AnyFileExtension-Console-GraphicInterface/releases/tag/v1.0.
9467
9568
Run it with the following command:
9669
```
9770
sudo ./ImageCompressor
9871
```
72+
73+
### Usage
74+
To use the Image Compressor tool, follow these steps:
75+
1. Run "ImageCompressor.exe" to open the main menu:
76+
77+
![Main menu](image_url)
78+
79+
2. Click on the "Select Folder" button to choose the folder containing the images you want to compress. You can check the currently selected directory at the bottom of the latest dropdown menu:
80+
81+
![Selected path](image_url)
82+
83+
3. After selecting the folder, click on the "Compress" button to begin the compression process.
84+
4. Once the compression is complete, the tool will automatically close after 2 seconds.
9985
10086
## Build (Advanced User) [Not necessary]
10187
### Requirements
@@ -107,7 +93,7 @@ Note that there are pre-built versions available for Windows and Linux (tested o
10793
### How to build [Option 1 - Using megerd.py] [Recommended]
10894
1. Open a terminal and navigate to the main folder of the project.
10995
2. Run the following command:
110-
96+
3. Once the compression is complete, the tool will automatically close after 2 seconds.
11197
```
11298
pyinstaller --onefile --name=ImageCompressor ./src/megerd.py
11399
```
@@ -156,7 +142,13 @@ Note that there are pre-built versions available for Windows and Linux (tested o
156142
```
157143
sudo ./dist/ImageCompressor
158144
```
159-
145+
## FAQ
146+
- Does this program copy empty (0 bit) images?
147+
148+
No, empty images are not copied.
149+
- What image formats are supported by ImageCompressor?
150+
151+
ImageCompressor supports the same image formats as the Pillow library, which includes popular formats such as JPEG, PNG, BMP, GIF, and TIFF, among others.
160152
## Authors
161153
CrashyProjects
162154
## License

0 commit comments

Comments
 (0)