Skip to content

Commit ed318f6

Browse files
committed
docs(readme): update documentation links in the README file
Signed-off-by: k4yt3x <i@k4yt3x.com>
1 parent 862b7f4 commit ed318f6

File tree

3 files changed

+22
-15
lines changed

3 files changed

+22
-15
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,24 @@
22
<img src="https://github.com/user-attachments/assets/5cd63373-e806-474f-94ec-6e04963bf90f"/>
33
</br>
44
<img src="https://img.shields.io/github/v/release/k4yt3x/video2x?style=flat-square"/>
5-
<img src="https://img.shields.io/github/actions/workflow/status/k4yt3x/video2x/build.yml?label=Build&style=flat-square"/>
65
<img src="https://img.shields.io/github/downloads/k4yt3x/video2x/total?style=flat-square"/>
76
<img src="https://img.shields.io/github/license/k4yt3x/video2x?style=flat-square"/>
87
<img src="https://img.shields.io/github/sponsors/k4yt3x?style=flat-square&link=https%3A%2F%2Fgithub.com%2Fsponsors%2Fk4yt3x"/>
98
<img src="https://img.shields.io/badge/dynamic/json?color=%23e85b46&label=Patreon&query=data.attributes.patron_count&suffix=%20patrons&url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F4507807&style=flat-square"/>
109
</p>
1110

12-
> [!IMPORTANT]
13-
> Versions 4 and 5 have reached end-of-life (EOL) status. Due to limited development resources, issues related to any version earlier than 6 will no longer be addressed.
14-
1511
## 🌟 Version 6.0.0
1612

17-
**[Download Windows Installer](https://github.com/k4yt3x/video2x/releases/download/6.1.1/video2x-qt6-windows-amd64-installer.exe)**
13+
Video2X 6.0.0 highlights:
1814

19-
**TL;DR: Version 6.0.0 is a complete rewrite of the Video2X project in C/C++, featuring a faster, more efficient architecture, cross-platform support, vastly improved output quality, and a new GUI and installer for easy setup on Windows.**
15+
- Complete rewrite of the Video2X project in C/C++.
16+
- Faster and more efficient architecture.
17+
- Cross-platform support for Windows and Linux.
18+
- Vastly improved output quality.
19+
- New GUI and installer for easy setup on Windows.
2020

21-
![6.1.0-screenshot](https://github.com/user-attachments/assets/57aa11d0-dd01-49e9-b6b0-2d2f21a363ac)
21+
<details>
22+
<summary>Click to see more details</summary>
2223

2324
Version 6.0.0 is a complete rewrite of this project in C/C++. It:
2425

@@ -29,13 +30,19 @@ Version 6.0.0 is a complete rewrite of this project in C/C++. It:
2930
- supports Anime4K v4 and all custom MPV-compatible GLSL shaders;
3031
- includes support for RealESRGAN (all three models) via ncnn and Vulkan;
3132
- requires zero additional disk space during processing, just space for the final output; and
32-
- exports a standard C function for easy integration into other projects! (documentations are on the way)
33+
- exports a standard C function for easy integration into other projects! (documentation is on the way)
3334

3435
Support for RealCUGAN and frame interpolation with RIFE are coming soon.
3536

37+
</details>
38+
39+
![6.1.0-screenshot](https://github.com/user-attachments/assets/57aa11d0-dd01-49e9-b6b0-2d2f21a363ac)
40+
3641
## [🪟 Download for Windows](https://github.com/k4yt3x/video2x/releases/latest)
3742

38-
You can download the latest Windows release from the [releases page](https://github.com/k4yt3x/video2x/releases/latest). For basic GUI usage, refer to the [GUI wiki page](https://github.com/k4yt3x/video2x/wiki/GUI). If you're unable to download directly from GitHub, try the [mirror](https://files.k4yt3x.com/Projects/Video2X/latest). The GUI currently supports the following languages:
43+
**[Download Latest Windows Installer Executable (6.1.1)](https://github.com/k4yt3x/video2x/releases/download/6.1.1/video2x-qt6-windows-amd64-installer.exe)**
44+
45+
You can download the latest Windows release from the [releases page](https://github.com/k4yt3x/video2x/releases/latest). For basic GUI usage, refer to the [documentation](https://docs.video2x.org/running/desktop.html). If you're unable to download directly from GitHub, try the [mirror](https://files.k4yt3x.com/Projects/Video2X/latest). The GUI currently supports the following languages:
3946

4047
- English (United States)
4148
- 简体中文(中国)
@@ -48,7 +55,7 @@ You can install Video2X on Arch Linux using the [video2x-git](https://aur.archli
4855

4956
## [📦 Container Image](https://github.com/k4yt3x/video2x/pkgs/container/video2x)
5057

51-
Video2X container images are available on the GitHub Container Registry for easy deployment on Linux and macOS. If you already have Docker/Podman installed, only one command is needed to start upscaling a video. For more information on how to use Video2X's Docker image, please refer to the [documentations](https://github.com/K4YT3X/video2x/wiki/Container).
58+
Video2X container images are available on the GitHub Container Registry for easy deployment on Linux and macOS. If you already have Docker/Podman installed, only one command is needed to start upscaling a video. For more information on how to use Video2X's Docker image, please refer to the [documentation](https://docs.video2x.org/running/container.html).
5259

5360
## [📔 Google Colab](https://colab.research.google.com/drive/1gWEwcA9y57EsxwOjmLNmNMXPsafw0kGo)
5461

@@ -58,9 +65,9 @@ You can use Video2X on [Google Colab](https://colab.research.google.com/) **for
5865

5966
Join our Telegram discussion group to ask any questions you have about Video2X, chat directly with the developers, or discuss about super resolution technologies and the future of Video2X in general.
6067

61-
## [📖 Documentations](https://github.com/k4yt3x/video2x/wiki)
68+
## [📖 Documentation](https://docs.video2x.org/)
6269

63-
Video2X's documentations are hosted on this repository's [Wiki page](https://github.com/k4yt3x/video2x/wiki). It includes comprehensive explanations for how to use the [GUI](https://github.com/k4yt3x/video2x/wiki/GUI), the [CLI](https://github.com/k4yt3x/video2x/wiki/CLI), the [container image](https://github.com/K4YT3X/video2x/wiki/Container), the [library](https://github.com/k4yt3x/video2x/wiki/Library), and more. The Wiki is open to edits by the community, so you, yes you, can also correct errors or add new contents to the documentations.
70+
Comprehensive documentation for Video2X is available at [https://docs.video2x.org/](https://docs.video2x.org/). It offers detailed instructions on how to [build](https://docs.video2x.org/building/index.html), [install](https://docs.video2x.org/installing/index.html), [use](https://docs.video2x.org/running/index.html), and [develop](https://docs.video2x.org/developing/index.html) with this program.
6471

6572
## Introduction
6673

docs/book/book.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
authors = ["k4yt3x"]
33
language = "en"
44
multilingual = false
5-
title = "Video2X Documentations"
5+
title = "Video2X Documentation"
66

77
[output.html]
88
default-theme = "ayu"

docs/book/src/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
<img src="https://github.com/user-attachments/assets/5cd63373-e806-474f-94ec-6e04963bf90f"/>
55
</p>
66

7-
This site hosts the documentations for the Video2X project, a machine learning-based lossless video super resolution & frame interpolation framework.
7+
This site hosts the documentation for the Video2X project, a machine learning-based lossless video super-resolution and frame interpolation framework.
88

99
The project's homepage is located on GitHub at: [https://github.com/k4yt3x/video2x](https://github.com/k4yt3x/video2x).
1010

11-
If you have any questions, suggestions, or found any issues in the documentations, please [open an issue](https://github.com/k4yt3x/video2x/issues/new/choose) on GitHub.
11+
If you have any questions, suggestions, or found any issues in the documentation, please [open an issue](https://github.com/k4yt3x/video2x/issues/new/choose) on GitHub.
1212

1313
> 🚧 Some pages are still under construction.

0 commit comments

Comments
 (0)