Skip to content

Commit b8a9e17

Browse files
committed
add README
1 parent 7113e85 commit b8a9e17

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# QOI image compression
2+
3+
Python implementation of QOI encoder and decoder
4+
5+
QOI format: https://qoiformat.org/
6+
7+
8+
## Usage
9+
10+
**1) Encode single .png image and save .qoi image**
11+
12+
At the end of `qoi_encoder.py` enter path to .png image and run:
13+
```
14+
python3 qoi_encoder.py
15+
```
16+
17+
18+
**2) Decode single .qoi image**
19+
20+
At the end of `qoi_decoder.py` enter path to .qoi image and run:
21+
```
22+
python3 qoi_decoder.py
23+
```
24+
25+
26+
**3) Encode and decode all .png images in some directory, compare decoded .qoi image with original .png image**
27+
28+
At the end of `main.py` choose `dir_with_png` and uncomment line with `run_multiple_experiments(dir_with_png)`, then run:
29+
```
30+
python3 main.py
31+
```
32+

0 commit comments

Comments
 (0)