Skip to content

Commit ccfc3bf

Browse files
committed
added usage section
Signed-off-by: Cocoa <[email protected]>
1 parent 643d26f commit ccfc3bf

File tree

1 file changed

+56
-13
lines changed

1 file changed

+56
-13
lines changed

README.md

Lines changed: 56 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,62 @@ As its long long name suggested.
99
### Thanks
1010
Thanks to [@shincurry](https://github.com/shincurry) for contributing to the UI of this project.
1111

12+
### Usage
13+
14+
#### Single Mode
15+
1. Click `Single` on the top tab
16+
2. Drag and drop the image you intentded to upscale to the left image cell
17+
3. Adjust the settings at the bottom
18+
4. Click `2x!` and the generated image will be shown at the right image cell
19+
5. Drag the image from the right image cell to where you want to save it (the filename will be `waifu2x-output.png`)
20+
21+
![screenshot](screenshot-v1.4-single-image.png)
22+
23+
#### Multiple Mode
24+
1. Click `Multiple` on the top tab
25+
2. Drag and drop images or directories to the table. (Only decodable images will be processed)
26+
3. Adjust the settings at the bottom
27+
4. Click `2x!` and the generated images will be saved at where them from with an extra `.png` extension. For example,
28+
29+
Input
30+
31+
```
32+
.
33+
├── 1
34+
│   ├── IMG_2185.JPG
35+
│   ├── IMG_2211.JPG
36+
│   └── IMG_2212.JPG
37+
├── 2
38+
│   └── IMG_2208.PNG
39+
└── IMG_2213.JPG
40+
```
41+
42+
Output
43+
```
44+
.
45+
.
46+
├── 1
47+
│   ├── IMG_2185.JPG
48+
│   ├── IMG_2185.JPG.png
49+
│   ├── IMG_2211.JPG
50+
│   ├── IMG_2211.JPG.png
51+
│   ├── IMG_2212.JPG
52+
│   └── IMG_2212.JPG.png
53+
├── 2
54+
│   ├── IMG_2208.PNG
55+
│   └── IMG_2208.PNG.png
56+
├── IMG_2213.JPG
57+
└── IMG_2213.JPG.png
58+
```
59+
60+
![screenshot](screenshot-v1.4-multiple-images.png)
61+
62+
#### Benchmark
63+
64+
To run benchmark, please click `waifu2x-gui` -> `Benchmark`
65+
66+
![screenshot](screenshot-v1.4-benchmark.png)
67+
1268
### Build Instructions
1369
Download lastest Vulkan SDK at [https://vulkan.lunarg.com/sdk/home](https://vulkan.lunarg.com/sdk/home).
1470

@@ -59,19 +115,6 @@ After the first compilation, if you want to modify this project only, you may se
59115

60116
![regenerate_shader](regenerate_shader.png)
61117

62-
### Screenshot
63-
64-
#### Single Mode
65-
![screenshot](screenshot-v1.4-single-image.png)
66-
67-
#### Multiple Mode
68-
![screenshot](screenshot-v1.4-multiple-images.png)
69-
70-
#### Benchmark
71-
To run benchmark, please click "waifu2x-gui" -> "Benchmark"
72-
73-
![screenshot](screenshot-v1.4-benchmark.png)
74-
75118
## Speed Comparison between Macs
76119

77120
### Environment 1

0 commit comments

Comments
 (0)