Update Simplified Chinese and Adjust All READMEs (#1045)

* Update Simplified Chinese Translation * Adjust the Format of All READMEs * Fix missing values --------- Co-authored-by: ScrubN <72096833+ScrubN@users.noreply.github.com>
lay295 · May 1, 2024 · b6142f3 · b6142f3
1 parent 49709e0
commit b6142f3
Show file tree

Hide file tree

Showing 9 changed files with 705 additions and 207 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,8 @@
 <div align="center">
   <a href="https://github.com/lay295/TwitchDownloader">
-    <img src="TwitchDownloaderWPF/Images/Logo.png" alt="Logo" width="80" height="80"> 
+    <img src="TwitchDownloaderWPF/Images/Logo.png" alt="Logo" width="80" height="80">
   </a>
-
   <h3 align="center">Twitch Downloader</h3>
-
   <div align="center">
     Twitch VOD/Clip/Chat Downloader and Chat Renderer
     <br />
@@ -14,16 +12,17 @@
 </div>
 
 This document is also available in:
+
 - [**Spanish / Español**](README_es.md)
 - [**Italian / Italiano**](README_it.md)
-- [**Portuguese (Brazil) / Português (Brasil)**](README_ptbr.md)
+- [**Portuguese (Brazil) / Português (Brasil)**](README_pt-br.md)
 - [**Turkish / Türkçe**](README_tr.md)
 - [**Japanese / 日本語 (翻訳作業中 WIP)**](README_ja.md)
+- [**Simplified Chinese / 简体中文**](README_zh-cn.md)
 
 ## Chat Render Example
 
-https://user-images.githubusercontent.com/1060681/197653099-c3fd12c2-f03a-4580-84e4-63ce3f36be8d.mp4
-
+<https://user-images.githubusercontent.com/1060681/197653099-c3fd12c2-f03a-4580-84e4-63ce3f36be8d.mp4>
 
 ## What can it do?
 
@@ -39,26 +38,27 @@ https://user-images.githubusercontent.com/1060681/197653099-c3fd12c2-f03a-4580-8
 
 ![](https://i.imgur.com/bLegxGX.gif)
 
-### [See the full WPF documentation here](TwitchDownloaderWPF/README.md).
+### [See the full WPF documentation here](TwitchDownloaderWPF/README.md)
 
 ### Functionality
 
 The Windows WPF GUI implements all of the main functions of the program along with some extra quality of life functions:
+
 - Queue up multiple download/render jobs to run simultaneously
 - Create a list of download jobs from a list of vod/clip links
 - Search for and download multiple VODs/clips from any streamer without leaving the app
 
 ### Multi-language Support
 
-The Windows WPF GUI is available in multiple languages thanks to community translations. See the [Localization section](TwitchDownloaderWPF/README.md#localization) of the [WPF README](TwitchDownloaderWPF/README.md) for more details. 
+The Windows WPF GUI is available in multiple languages thanks to community translations. See the [Localization section](TwitchDownloaderWPF/README.md#localization) of the [WPF README](TwitchDownloaderWPF/README.md) for more details.
 
 ### Theming
 
 The Windows WPF GUI comes bundled with both light and dark themes, along with an option to update live according the current Windows theme. It also supports user created themes! See the [Theming section](TwitchDownloaderWPF/README.md#theming) of the [WPF README](TwitchDownloaderWPF/README.md) for more details.
 
 ### Video Demonstration
 
-https://www.youtube.com/watch?v=0W3MhfhnYjk
+<https://www.youtube.com/watch?v=0W3MhfhnYjk>
 (older version, same concept)
 
 ## Linux?
@@ -71,13 +71,14 @@ No GUI is available for MacOS yet :(
 
 # CLI
 
-### [See the full CLI documentation here](TwitchDownloaderCLI/README.md).
+### [See the full CLI documentation here](TwitchDownloaderCLI/README.md)
 
 The CLI is cross-platform and implements the main functions of the program. It works on Windows, Linux, and MacOS<sup>*</sup>.
 
 <sup>*Only Intel Macs have been tested</sup>
 
 With the CLI, it is possible to automate video processing using external scripts. For example, you could copy-paste the following code into a `.bat` file on Windows to download a VOD and its chat, and then render the chat, all from a single input.
+
 ```bat
 @echo off
 set /p vodid="Enter VOD ID: "
@@ -91,17 +92,23 @@ TwitchDownloaderCLI.exe chatrender -i %vodid%_chat.json -h 1080 -w 422 --framera
 1. Go to [Releases](https://github.com/lay295/TwitchDownloader/releases/) and download the latest version for Windows or [build from source](#building-from-source).
 2. Extract `TwitchDownloaderCLI.exe`.
 3. Browse to where you extracted the executable:
+
 ```
 cd C:\folder\containing\TwitchDownloaderCLI
 ```
+
 4. If you do not have FFmpeg, you can install it via [Chocolatey package manager](https://community.chocolatey.org/), or you can get it as a standalone file from [ffmpeg.org](https://ffmpeg.org/download.html) or by using TwitchDownloaderCLI:
+
 ```
 TwitchDownloaderCLI.exe ffmpeg --download
 ```
+
 5. You can now start using TwitchDownloaderCLI, for example:
+
 ```
 TwitchDownloaderCLI.exe videodownload --id <vod-id-here> -o out.mp4
 ```
+
 You can find more example commands in the [CLI README](TwitchDownloaderCLI/README.md#example-commands).
 
 ## Linux – Getting started
@@ -111,54 +118,77 @@ You can find more example commands in the [CLI README](TwitchDownloaderCLI/READM
 3. Go to [Releases](https://github.com/lay295/TwitchDownloader/releases/) and download the latest binary for Linux, grab the [AUR Package](https://aur.archlinux.org/packages/twitch-downloader-bin/) for Arch Linux, or [build from source](#building-from-source).
 4. Extract `TwitchDownloaderCLI`.
 5. Browse to where you extracted the binary:
+
 ```
 cd directory/containing/TwitchDownloaderCLI
 ```
+
 6. Give the binary executable rights:
+
 ```
 sudo chmod +x TwitchDownloaderCLI
 ```
+
 7. a) If you do not have FFmpeg, you should install it system-wide via your distro package manager, however you can also get it as a standalone file from [ffmpeg.org](https://ffmpeg.org/download.html) or by using TwitchDownloaderCLI:
+
 ```
 ./TwitchDownloaderCLI ffmpeg --download
 ```
+
 7. b) If downloaded as a standalone file, you must also give it executable rights with:
+
 ```
 sudo chmod +x ffmpeg
 ```
+
 8. You can now start using TwitchDownloaderCLI, for example:
+
 ```
 ./TwitchDownloaderCLI videodownload --id <vod-id-here> -o out.mp4
 ```
+
 You can find more example commands in the [CLI README](TwitchDownloaderCLI/README.md#example-commands).
 
 ## MacOS – Getting started
+
 1. If your device has an Apple Silicon M-series processor, ensure that you download the arm64 binary, however if you would like to use the x64 binary on Apple Silicon it must be run via a terminal session running under Rosetta 2:
+
 ```
 arch -x86_64 zsh
 ```
+
 2. Go to [Releases](https://github.com/lay295/TwitchDownloader/releases/) and download the latest binary for MacOS or [build from source](#building-from-source).
 3. Extract `TwitchDownloaderCLI`.
 4. Browse to where you extracted the binary:
+
 ```
 cd directory/containing/TwitchDownloaderCLI
 ```
+
 5. Give the binary executable rights in the terminal:
+
 ```
 chmod +x TwitchDownloaderCLI
 ```
+
 6. a) If you do not have FFmpeg, you can install it system-wide via the [Homebrew package manager](https://brew.sh/), or you can get it as a standalone file from [ffmpeg.org](https://ffmpeg.org/download.html) or by using TwitchDownloaderCLI:
+
 ```
 ./TwitchDownloaderCLI ffmpeg --download
 ```
+
 6. b) If downloaded as a standalone file, you must also give it executable rights with:
+
 ```
 chmod +x ffmpeg
 ```
+
 7. You can now start using TwitchDownloaderCLI, for example:
+
 ```
 ./TwitchDownloaderCLI videodownload --id <vod-id-here> -o out.mp4
 ```
+
 You can find more example commands in the [CLI README](TwitchDownloaderCLI/README.md#example-commands).
 
 # Building from source
@@ -171,32 +201,47 @@ You can find more example commands in the [CLI README](TwitchDownloaderCLI/READM
 ## Build Instructions
 
 1. Clone the repository:
+
 ```
 git clone https://github.com/lay295/TwitchDownloader.git
 ```
+
 2. Navigate to the solution folder:
+
 ```
 cd TwitchDownloader
 ```
+
 3. Restore the solution:
+
 ```
 dotnet restore
 ```
+
 - Non-Windows devices may need to explicitly specify a project to restore, i.e. `dotnet restore TwitchDownloaderCLI`
+
 4. a) Build the GUI:
+
 ```
 dotnet publish TwitchDownloaderWPF -p:PublishProfile=Windows
 ```
+
 4. b) Build the CLI:
+
 ```
 dotnet publish TwitchDownloaderCLI -p:PublishProfile=<Profile>
 ```
+
 - Applicable Profiles: `Windows`, `Linux`, `LinuxAlpine`, `LinuxArm`, `LinuxArm64`, `MacOS`, `MacOSArm64`
+
 5. a) Navigate to the GUI build folder:
+
 ```
 cd TwitchDownloaderWPF/bin/Release/net6.0-windows/publish/win-x64
 ```
+
 5. b) Navigate to the CLI build folder:
+
 ```
 cd TwitchDownloaderCLI/bin/Release/net6.0/publish
 ```
@@ -223,4 +268,4 @@ For a full list of utilized external libraries, see [THIRD-PARTY-LICENSES.txt](.
 
 [MIT](./LICENSE.txt)
 
-TwitchDownloader is in no way associated with Twitch Interactive, Inc. or its affiliates.
+TwitchDownloader is in no way associated with Twitch Interactive, Inc. or its affiliates.
diff --git a/README_es.md b/README_es.md
@@ -2,9 +2,7 @@
   <a href="https://github.com/lay295/TwitchDownloader">
     <img src="TwitchDownloaderWPF/Images/Logo.png" alt="Logo" width="80" height="80">
   </a>
-
   <h3 align="center">Twitch Downloader</h3>
-
   <div align="center">
     Descargador de Twitch VOD/Clip/Chat y Renderizador de Chat
     <br />
@@ -17,7 +15,7 @@
 
 ## Ejemplo de Renderizado de Chat
 
-https://user-images.githubusercontent.com/1060681/197653099-c3fd12c2-f03a-4580-84e4-63ce3f36be8d.mp4
+<https://user-images.githubusercontent.com/1060681/197653099-c3fd12c2-f03a-4580-84e4-63ce3f36be8d.mp4>
 
 ## ¿Qué puede hacer?
 
@@ -33,11 +31,12 @@ https://user-images.githubusercontent.com/1060681/197653099-c3fd12c2-f03a-4580-8
 
 ![](https://i.imgur.com/bLegxGX.gif)
 
-### [Ver toda la documentación de WPF aquí](TwitchDownloaderWPF/README.md).
+### [Ver toda la documentación de WPF aquí](TwitchDownloaderWPF/README.md)
 
 ### Funcionalidad
 
 La interfaz gráfica de usuario Windows WPF implementa todas las funciones principales del programa junto con algunas funciones adicionales para mejorar la comodidad de uso:
+
 - Agregar múltiples tareas de descarga/renderizado a la cola para ejecutarlas simultáneamente
 - Crear una lista de tareas de descarga a partir de una lista de enlaces de VODs/Clips
 - Buscar y descargar múltiples VODs/Clips de cualquier streamer sin salir de la aplicación
@@ -52,7 +51,7 @@ La interfaz gráfica de usuario Windows WPF incluye temas claros y oscuros, junt
 
 ### Demostración en Video
 
-https://www.youtube.com/watch?v=0W3MhfhnYjk
+<https://www.youtube.com/watch?v=0W3MhfhnYjk>
 (versión anterior, mismo concepto)
 
 ## ¿Linux?
@@ -65,7 +64,7 @@ Por ahora, no hay una GUI disponible para MacOS :(
 
 # Interfaz de Línea de Comandos (CLI)
 
-### [Ver toda la documentación de la CLI aquí](TwitchDownloaderCLI/README.md).
+### [Ver toda la documentación de la CLI aquí](TwitchDownloaderCLI/README.md)
 
 La interfaz de línea de comandos (CLI) es multiplataforma e implementa las funciones principales del programa. Funciona en Windows, Linux y MacOS<sup>*</sup>.
 
@@ -87,10 +86,13 @@ TwitchDownloaderCLI.exe chatrender -i %vodid%_chat.json -h 1080 -w 422 --framera
 2. Extrae `TwitchDownloaderCLI.exe`.
 3. Navega hasta el lugar donde extrajiste el archivo en la terminal.
 4. Si no tienes FFmpeg, puedes instalarlo a través del [administrador de paquetes Chocolatey](https://community.chocolatey.org/), o puedes obtenerlo como un archivo independiente desde [ffmpeg.org](https://ffmpeg.org/download.html) o utilizando TwitchDownloaderCLI:
+
 ```
 TwitchDownloaderCLI.exe ffmpeg --download
 ```
+
 5. Ahora puedes empezar a usar el descargador, por ejemplo:
+
 ```
 TwitchDownloaderCLI.exe videodownload --id <id-del-vod-aquí> -o out.mp4
 ```
@@ -104,18 +106,25 @@ TwitchDownloaderCLI.exe videodownload --id <id-del-vod-aquí> -o out.mp4
 building-from-source).
 4. Extrae `TwitchDownloaderCLI`.
 5. Navega hasta el lugar donde extrajiste el archivo y dale permisos de ejecución en la terminal:
+
 ```
 sudo chmod +x TwitchDownloaderCLI
 ```
+
 6. a) Si no tienes FFmpeg, debes instalarlo a través del administrador de paquetes de tu distribución, aunque también puedes obtenerlo como un archivo independiente desde [ffmpeg.org](https://ffmpeg.org/download.html) o usando TwitchDownloaderCLI:
+
 ```
 ./TwitchDownloaderCLI ffmpeg --download
 ```
+
 6. b) Si lo descargaste como un archivo independiente, también debes darle permisos de ejecución con:
+
 ```
 sudo chmod +x ffmpeg
 ```
+
 7. Ahora puedes empezar a usar el descargador, por ejemplo:
+
 ```
 ./TwitchDownloaderCLI videodownload --id <id-del-vod-aquí> -o out.mp4
 ```
@@ -125,18 +134,25 @@ sudo chmod +x ffmpeg
 1. Ve a [Releases](https://github.com/lay295/TwitchDownloader/releases/) y descarga el archivo binario más reciente para MacOS o [compila desde el código fuente](#building-from-source).
 2. Extrae `TwitchDownloaderCLI`.
 3. Navega hasta el lugar donde extrajiste el archivo y dale permisos de ejecución en la terminal:
+
 ```
 chmod +x TwitchDownloaderCLI
 ```
+
 4. a) Si no tienes FFmpeg, puedes instalarlo a través del [administrador de paquetes Homebrew](https://brew.sh/), o puedes obtenerlo como un archivo independiente desde [ffmpeg.org](https://ffmpeg.org/download.html) o utilizando TwitchDownloaderCLI:
+
 ```
 ./TwitchDownloaderCLI ffmpeg --download
 ```
+
 4. b) Si lo descargaste como un archivo independiente, también debes darle permisos de ejecución con:
+
 ```
 chmod +x ffmpeg
 ```
+
 5. Ahora puedes empezar a usar el descargador, por ejemplo:
+
 ```
 ./TwitchDownloaderCLI videodownload --id <id-del-vod-aquí> -o out.mp4
 ```
@@ -150,31 +166,45 @@ chmod +x ffmpeg
 ## Instrucciones de Compilación
 
 1. Clona el repositorio:
+
 ```
 git clone https://github.com/lay295/TwitchDownloader.git
 ```
+
 2. Navega hasta la carpeta de la solución:
+
 ```
 cd TwitchDownloader
 ```
+
 3. Restaura la solución:
+
 ```
 dotnet restore
 ```
+
 4. a) Compila la GUI:
+
 ```
 dotnet publish TwitchDownloaderWPF -p:PublishProfile=Windows
 ```
+
 4. b) Compila la CLI:
+
 ```
 dotnet publish TwitchDownloaderCLI -p:PublishProfile=<Perfil>
 ```
+
 - Perfiles aplicables: `Windows`, `Linux`, `LinuxAlpine`, `LinuxArm`, `LinuxArm64`, `MacOS`, `MacOSArm64`
+
 5. a) Navega hasta la carpeta de la compilación de la GUI:
+
 ```
 cd TwitchDownloaderWPF/bin/Release/net6.0-windows/publish/win-x64
 ```
+
 5. b) Navega hasta la carpeta de la compilación de la CLI:
+
 ```
 cd TwitchDownloaderCLI/bin/Release/net6.0/publish
 ```