Skip to content

Commit 2ba206a

Browse files
committed
Update README.md
1 parent 5147b91 commit 2ba206a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Reduce Image Size
22

3+
## Description
34
Reduces size of images in a folder (and optionally sub-folders, recursively).
45

56
Supports JPEG and PNG formats.
@@ -21,13 +22,15 @@ A user can experiment with the `resize` and the `quality` arguments.
2122
Also, the user can go only one level deep and not recursively, or simply experiment on a copy of an image folder.
2223
If satisfied with the result, original images can be deleted afterwards easily to save disk and/or cloud space.
2324

24-
Options:
25+
## Options
2526
- Look into subdirectories recursively (process the entire tree); recommended: `-r`, `--recursive`
2627
- Reduce both image dimensions by half: `--resize`
2728
- JPEG quality, on a scale from 1 (worst) to 100 (best); the default is 75; ignored in case of PNGs: `--quality <QUALITY>`
2829

30+
## Notes
2931
Developed in Rust 1.74.1.
3032
Tested on an x86-64 CPU with Windows 11 with JPEGs and PNGs.
33+
Also tested on WSL - Ubuntu 22.04.2 LTS (GNU/Linux 5.15.133.1-microsoft-standard-WSL2 x86_64) on Windows 11.
3134
Other OSes haven't been tested, but should work.
3235

3336
## Running the Application
@@ -50,7 +53,7 @@ Or, provide full path to the program.
5053

5154
Paths to the source and destination folders can be absolute or relative.
5255

53-
### Building the Application and Running it With cargo
56+
## Building the Application and Running it With cargo
5457
This section applies in case you don't have an executable and need to build it.
5558
It doesn't depend on the OS.
5659

0 commit comments

Comments
 (0)