Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
TransparentLC committed Mar 20, 2024
1 parent 7ede815 commit b5f5105
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 2 deletions.
45 changes: 44 additions & 1 deletion README.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ A cross-platform GUI for image upscaler [Real-ESRGAN](https://github.com/xinntao
* [简体中文 (Simplified Chinese)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.md)
* [English](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.en-US.md)
* [Ukrainian (Українська)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.uk-UA.md) Translated by [@kirill0ermakov](https://github.com/kirill0ermakov)
* [Türkçe (Turkish)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.tr-TR.md) Translated by [@NandeMD](https://github.com/NandeMD) tarafından

</details>

Expand Down Expand Up @@ -46,6 +47,8 @@ Quick Start:

</details>

Please check out [CONTRIBUTING.md](https://github.com/TransparentLC/realesrgan-gui/blob/master/CONTRIBUTING.md) if you would like to contribute to Real-ESRGAN GUI.

### Build `Real-ESRGAN GUI.app` for Apple Silicon (`arm64`)

The `arm64` builds have been tested to perform better than `universal2` builds. If you are using Apple Silicon, it is recommended that you can make an `arm64` build by yourself.
Expand Down Expand Up @@ -195,6 +198,32 @@ These model uses PyTorch's `pth` format, but Real-ESRGAN GUI (Real-ESRGAN-ncnn-v

You can download some converted additional models from [here](https://github.com/TransparentLC/realesrgan-gui/releases/tag/additional-models).

### Why not (other similar GUI)?

Of course, there is more than one GUI for Real-ESRGAN. Here is a list of some, with reasons why I didn't use them and decided to build on my own.

#### [Waifu2x-Extension-GUI](https://github.com/AaronFeng753/Waifu2x-Extension-GUI) ![](https://img.shields.io/github/stars/AaronFeng753/Waifu2x-Extension-GUI)

This is an all-in-one toolbox that integrates tons of tools, including waifu2x, Anime4k, Real-SR, SRMD, Real-ESRGAN, Real-CUGAN ... for image upscaling and CAIN, DAIN, RIFE ... for video frame interpolation and other utils including ffmpeg, ImageMagick, gifsicle, nircmd, wget and more. Only supported on Windows.

The rich feature set leads to a complex UI and configurations, however I only need a small number of its features. I used to be a user of it when it was open source, but then the author [modified LICENSE](https://github.com/AaronFeng753/Waifu2x-Extension-GUI/commit/) and [switched to closed source](https://github.com/AaronFeng753/Waifu2x-Extension-GUI/commit/38b13ed886f50d861798e8cad3cc056f04173415) since v3.41.01 in May 2021. Moreover, the advertisement of the premium version appears every time when it starts up and finishes processing.

Although I don't rely on those premium-only features, the changes still encourages me to write another lightweight GUI that meets my needs.

#### [upscayl](https://github.com/upscayl/upscayl) ![](https://img.shields.io/github/stars/upscayl/upscayl)

Built with Electron, so it is also cross-platform. Benefiting from the power of front-end technologies, the UI and interaction are excellent and there is even a comparison slider between the original image and the upscaled image. The documentation is also very detailed.

However, it still lacks some features such as handling GIFs, customizing post-processing commands, and [localization](https://github.com/upscayl/upscayl/issues/91).

Since it is an Electron application, the users will have to [install yet another Chromium browser](https://github.com/ShirasawaSama/CefDetector/raw/master/screenshot.png)😂 The size of Upscayl is about 400 MB while Real-ESRGAN GUI is only about 10 MB (Windows version, excluding Real-ESRGAN-ncnn-vulkan's executable and models).

#### [tsukumijima/Real-ESRGAN-GUI](https://github.com/tsukumijima/Real-ESRGAN-GUI) ![](https://img.shields.io/github/stars/tsukumijima/Real-ESRGAN-GUI)[net2cn/Real-ESRGAN_GUI](https://github.com/net2cn/Real-ESRGAN_GUI) ![](https://img.shields.io/github/stars/net2cn/Real-ESRGAN_GUI)[upscale-rs](https://github.com/oloko64/upscale-rs) ![](https://img.shields.io/github/stars/oloko64/upscale-rs)[Real-ESRGAN-EGUI](https://github.com/WGzeyu/Real-ESRGAN-EGUI) ![](https://img.shields.io/github/stars/WGzeyu/Real-ESRGAN-EGUI) ……

These GUIs are simple wrappers for the CLI parameters without any extra features.

However, I like the Material Design used by tsukumijima/Real-ESRGAN-GUI.

## Open-source libraries used

* [Pillow](https://github.com/python-pillow/Pillow)
Expand All @@ -206,4 +235,18 @@ You can download some converted additional models from [here](https://github.com

## Credits

* Thanks [@blacklein](https://github.com/blacklein) and [@hyrulelinks](https://github.com/hyrulelinks) for offering helps on using and bundling this application in macOS.
Thanks [@blacklein](https://github.com/blacklein) and [@hyrulelinks](https://github.com/hyrulelinks) for offering helps on using and bundling this application in macOS.

And other contributors!

[![Contributors](https://contrib.rocks/image?repo=TransparentLC/realesrgan-gui)](https://github.com/TransparentLC/realesrgan-gui/graphs/contributors)

## Star history

<a href="https://star-history.com/#TransparentLC/realesrgan-gui&Date">
<picture>
<source media="(prefers-color-scheme:dark)" srcset="https://api.star-history.com/svg?repos=TransparentLC/realesrgan-gui&type=Date&theme=dark" />
<source media="(prefers-color-scheme:light)" srcset="https://api.star-history.com/svg?repos=TransparentLC/realesrgan-gui&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=TransparentLC/realesrgan-gui&type=Date" />
</picture>
</a>
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* [简体中文 (Simplified Chinese)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.md)
* [English](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.en-US.md)
* [Ukrainian (Українська)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.uk-UA.md) Translated by [@kirill0ermakov](https://github.com/kirill0ermakov)
* [Türkçe (Turkish)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.tr-TR.md) Translated by [@NandeMD](https://github.com/NandeMD)

</details>

Expand Down Expand Up @@ -46,6 +47,8 @@

</details>

如果你想要贡献 Real-ESRGAN GUI,请查看 [CONTRIBUTING.md](https://github.com/TransparentLC/realesrgan-gui/blob/master/CONTRIBUTING.md)

### 一键打包 `arm64``x86_64` 单架构的 `Real-ESRGAN GUI.app`

经实测,`arm64` 单架构比 `universal2` 双架构在 Apple 芯片 Mac 上的性能表现要更加出色,因此建议 Apple 芯片用户自行打包 `arm64` 单架构应用程序。
Expand Down Expand Up @@ -184,6 +187,32 @@ GIF 只支持最多 256 种 RGB 颜色的调色板并设定其中一种颜色为

如果因为配置文件的问题导致程序不能运行的话,可以先尝试将配置文件删除。

### 为什么不使用(其他功能类似的 GUI)?

Real-ESRGAN 的 GUI 当然不止一个,这里列出了其中的一部分,并且附上了我没有使用它们而且选择自己写一个 GUI 的理由。

#### [Waifu2x-Extension-GUI](https://github.com/AaronFeng753/Waifu2x-Extension-GUI) ![](https://img.shields.io/github/stars/AaronFeng753/Waifu2x-Extension-GUI)

这是一个“全家桶”类型的工具箱,它不仅整合了用于图像放大的 waifu2x、Anime4k、Real-SR、SRMD、Real-ESRGAN、Real-CUGAN……还包含了用于视频插帧的 CAIN、DAIN、RIFE,以及 ffmpeg、ImageMagick、gifsicle、nircmd、wget 等辅助工具。只支持 Windows。

不过,功能繁多也使它的界面和设定都变得非常复杂,但其中的大部分功能并不是我会用到的。在它是开源软件的时候我曾经是它的用户,但作者从 2021 年 5 月的 v3.41.01 开始[修改了 LICENSE](https://github.com/AaronFeng753/Waifu2x-Extension-GUI/commit/37a4b53d754bf58f740df0d9043f726c062efa71) 转为[闭源](https://github.com/AaronFeng753/Waifu2x-Extension-GUI/commit/38b13ed886f50d861798e8cad3cc056f04173415),并会在每次启动和处理完成时显示购买高级版的广告。

虽然我并不依赖那些高级版限定的功能,但这些改变还是使我产生了编写符合自己的需求的轻量级 GUI(也就是这个项目)的想法。

#### [upscayl](https://github.com/upscayl/upscayl) ![](https://img.shields.io/github/stars/upscayl/upscayl)

用 Electron 实现的 GUI,同样实现了跨平台。由于使用的是前端技术,界面和交互都很容易做得非常出色,甚至还有将原图和放大后的图片进行对比的功能。文档也非常详细。

不过它仍然缺少了一些功能,例如处理 GIF、自定义后处理命令等。另外,它目前[还没有多语言支持](https://github.com/upscayl/upscayl/issues/91)

另外,因为它是使用 Electron 实现的,所以它的用户又要[多安装一个 Chromium 内核了](https://github.com/ShirasawaSama/CefDetector/raw/master/screenshot.png)😂 Upscayl 的大小约为 400 MB,相比之下 Real-ESRGAN GUI 仅有 10 MB 左右(Windows 版,排除 Real-ESRGAN-ncnn-vulkan 主程序和模型)。

#### [tsukumijima/Real-ESRGAN-GUI](https://github.com/tsukumijima/Real-ESRGAN-GUI) ![](https://img.shields.io/github/stars/tsukumijima/Real-ESRGAN-GUI)[net2cn/Real-ESRGAN_GUI](https://github.com/net2cn/Real-ESRGAN_GUI) ![](https://img.shields.io/github/stars/net2cn/Real-ESRGAN_GUI)[upscale-rs](https://github.com/oloko64/upscale-rs) ![](https://img.shields.io/github/stars/oloko64/upscale-rs)[Real-ESRGAN-EGUI](https://github.com/WGzeyu/Real-ESRGAN-EGUI) ![](https://img.shields.io/github/stars/WGzeyu/Real-ESRGAN-EGUI) ……

这些 GUI 基本上都是对 CLI 参数的简单封装,没有多少额外的功能。

不过,我很喜欢 tsukumijima/Real-ESRGAN-GUI 使用的 Material Design 风格。

## 借物表

* [Pillow](https://github.com/python-pillow/Pillow)
Expand All @@ -195,4 +224,16 @@ GIF 只支持最多 256 种 RGB 颜色的调色板并设定其中一种颜色为

## 致谢

* 感谢 [@blacklein](https://github.com/blacklein)[@hyrulelinks](https://github.com/hyrulelinks) 提供在 macOS 下使用这个 GUI 和打包为应用程序的帮助。
感谢 [@blacklein](https://github.com/blacklein)[@hyrulelinks](https://github.com/hyrulelinks) 提供在 macOS 下使用这个 GUI 和打包为应用程序的帮助,还有其他的贡献者们!

[![Contributors](https://contrib.rocks/image?repo=TransparentLC/realesrgan-gui)](https://github.com/TransparentLC/realesrgan-gui/graphs/contributors)

## Star history

<a href="https://star-history.com/#TransparentLC/realesrgan-gui&Date">
<picture>
<source media="(prefers-color-scheme:dark)" srcset="https://api.star-history.com/svg?repos=TransparentLC/realesrgan-gui&type=Date&theme=dark" />
<source media="(prefers-color-scheme:light)" srcset="https://api.star-history.com/svg?repos=TransparentLC/realesrgan-gui&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=TransparentLC/realesrgan-gui&type=Date" />
</picture>
</a>
1 change: 1 addition & 0 deletions README.uk-UA.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* [简体中文 (Simplified Chinese)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.md)
* [English](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.en-US.md)
* [Ukrainian (Українська)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.uk-UA.md) Translated by [@kirill0ermakov](https://github.com/kirill0ermakov)
* [Türkçe (Turkish)](https://github.com/TransparentLC/realesrgan-gui/blob/master/README.tr-TR.md) Translated by [@NandeMD](https://github.com/NandeMD) tarafından

</details>

Expand Down

0 comments on commit b5f5105

Please sign in to comment.