From d0dbdf69f0484298a231a043b05d9abd66e1a2d0 Mon Sep 17 00:00:00 2001 From: Sakamoto Shiina <68018796+ShiinaSakamoto@users.noreply.github.com> Date: Wed, 23 Apr 2025 06:36:55 +0900 Subject: [PATCH] [Refactor] Organize readme files. --- README.md | 108 +----------------- docs/{ => img}/kofi_logo.png | Bin docs/{ => img}/main_window.png | Bin docs/{ => img}/patreon_logo_black.png | Bin docs/{ => img}/patreon_logo_white.png | Bin docs/{ => img}/pixiv_fanbox_black.png | Bin docs/{ => img}/pixiv_fanbox_white.png | Bin docs/{ => img}/supporter_section_border_d.png | Bin docs/{ => img}/supporter_section_border_l.png | Bin docs/{ => img}/vrct_logo.png | Bin docs/{ => img}/vrct_logo_black.png | Bin docs/{ => img}/vrct_logo_white.png | Bin docs/readmes/README.en.md | 107 +++++++++++++++++ README.ja.md => docs/readmes/README.ja.md | 30 ++--- README.ko.md => docs/readmes/README.ko.md | 30 ++--- .../readmes/README.zh-Hant.md | 30 ++--- 16 files changed, 153 insertions(+), 152 deletions(-) rename docs/{ => img}/kofi_logo.png (100%) rename docs/{ => img}/main_window.png (100%) rename docs/{ => img}/patreon_logo_black.png (100%) rename docs/{ => img}/patreon_logo_white.png (100%) rename docs/{ => img}/pixiv_fanbox_black.png (100%) rename docs/{ => img}/pixiv_fanbox_white.png (100%) rename docs/{ => img}/supporter_section_border_d.png (100%) rename docs/{ => img}/supporter_section_border_l.png (100%) rename docs/{ => img}/vrct_logo.png (100%) rename docs/{ => img}/vrct_logo_black.png (100%) rename docs/{ => img}/vrct_logo_white.png (100%) create mode 100644 docs/readmes/README.en.md rename README.ja.md => docs/readmes/README.ja.md (70%) rename README.ko.md => docs/readmes/README.ko.md (70%) rename README.zh-Hant.md => docs/readmes/README.zh-Hant.md (67%) diff --git a/README.md b/README.md index c7af06b9..ab3e36da 100644 --- a/README.md +++ b/README.md @@ -1,107 +1 @@ -
- - - - - VRCT Logo - - -
-
- -[![GitHub release](https://img.shields.io/github/v/release/misyaguziya/VRCT.svg)](https://github.com/misyaguziya/VRCT/releases) -[![Downloads](https://img.shields.io/github/downloads/misyaguziya/VRCT/total)](https://github.com/misyaguziya/VRCT/releases) -[![Licence](https://img.shields.io/github/license/misyaguziya/VRCT)](https://github.com/misyaguziya/VRCT/blob/master/LICENSE) -[![Booth](https://img.shields.io/badge/Store-Booth.pm-red)](https://misyaguziya.booth.pm/items/5155325) -[![Github Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-30363D?&logo=GitHub-Sponsors&logoColor=EA4AAA)](https://github.com/sponsors/misyaguziya) - -

-Become a VRCT Supporter on: -

- - - - - - PIXIV FANBOX - -   - - - - - - Patreon - -   - - - - Ko-fi - -   - -
- - - - - Supporter Section Border - - -
-
- -| **English** | [日本語](./README.ja.md) | [한국어](./README.ko.md) | [繁體中文](./README.zh-Hant.md) | - -

-VRCT is software that supports VRChat conversations with translation and transcription. -

- -![](docs/main_window.png) - -
- -# Download & Install -Download from anywhere you like. -- [Github.com](https://github.com/misyaguziya/VRCT/releases/) -- [BOOTH.pm](https://misyaguziya.booth.pm/items/5155325) - -Just download and run the exe. - -# What is VRCT? -VRCT is software that supports conversations between people who speak different languages by providing chat or voice translation. -These features are designed for use within VRChat. -*Although not supported, it is also used for other purposes such as watching movies. - -VRCT supports your conversations with -- 💬 **Send chat to VRChat** -- 🌐 **Translation** -- 🎙 **Transcription of audio from microphone** -- 🔈 **Transcription of audio from Speaker** - -# Documents -Initial setup, basic functions, and other features are also described. -- [Documents Link](https://mzsoftware.notion.site/VRCT-Documents-be79b7a165f64442ad8f326d86c22246?pvs=4) - -# How to Use (YouTube) -
- -[![](https://img.youtube.com/vi/rUTad037n8Q/0.jpg)](https://www.youtube.com/watch?v=rUTad037n8Q) - -
- -## Author -- [みしゃ(misyaguzi)](https://github.com/misyaguziya) (Main Development) -- [しいな(Shiina_12siy)](https://twitter.com/Shiina_12siy) (UI/UX, UI multilingual support) -- [レラ](https://github.com/soumt-r) (Technical Support) -- [どね](https://twitter.com/done_vrc) (Logo Design) - -## Thanks to our contributors - - - - ---- - -VRCT is not endorsed by VRChat and does not reflect the views or opinions of VRChat or anyone officially involved in producing or managing VRChat properties. VRChat and all associated properties are trademarks or registered trademarks of VRChat Inc. VRChat © VRChat Inc. \ No newline at end of file +docs/readmes/README.en.md \ No newline at end of file diff --git a/docs/kofi_logo.png b/docs/img/kofi_logo.png similarity index 100% rename from docs/kofi_logo.png rename to docs/img/kofi_logo.png diff --git a/docs/main_window.png b/docs/img/main_window.png similarity index 100% rename from docs/main_window.png rename to docs/img/main_window.png diff --git a/docs/patreon_logo_black.png b/docs/img/patreon_logo_black.png similarity index 100% rename from docs/patreon_logo_black.png rename to docs/img/patreon_logo_black.png diff --git a/docs/patreon_logo_white.png b/docs/img/patreon_logo_white.png similarity index 100% rename from docs/patreon_logo_white.png rename to docs/img/patreon_logo_white.png diff --git a/docs/pixiv_fanbox_black.png b/docs/img/pixiv_fanbox_black.png similarity index 100% rename from docs/pixiv_fanbox_black.png rename to docs/img/pixiv_fanbox_black.png diff --git a/docs/pixiv_fanbox_white.png b/docs/img/pixiv_fanbox_white.png similarity index 100% rename from docs/pixiv_fanbox_white.png rename to docs/img/pixiv_fanbox_white.png diff --git a/docs/supporter_section_border_d.png b/docs/img/supporter_section_border_d.png similarity index 100% rename from docs/supporter_section_border_d.png rename to docs/img/supporter_section_border_d.png diff --git a/docs/supporter_section_border_l.png b/docs/img/supporter_section_border_l.png similarity index 100% rename from docs/supporter_section_border_l.png rename to docs/img/supporter_section_border_l.png diff --git a/docs/vrct_logo.png b/docs/img/vrct_logo.png similarity index 100% rename from docs/vrct_logo.png rename to docs/img/vrct_logo.png diff --git a/docs/vrct_logo_black.png b/docs/img/vrct_logo_black.png similarity index 100% rename from docs/vrct_logo_black.png rename to docs/img/vrct_logo_black.png diff --git a/docs/vrct_logo_white.png b/docs/img/vrct_logo_white.png similarity index 100% rename from docs/vrct_logo_white.png rename to docs/img/vrct_logo_white.png diff --git a/docs/readmes/README.en.md b/docs/readmes/README.en.md new file mode 100644 index 00000000..b99a1da8 --- /dev/null +++ b/docs/readmes/README.en.md @@ -0,0 +1,107 @@ +
+ + + + + VRCT Logo + + +
+
+ +[![GitHub release](https://img.shields.io/github/v/release/misyaguziya/VRCT.svg)](https://github.com/misyaguziya/VRCT/releases) +[![Downloads](https://img.shields.io/github/downloads/misyaguziya/VRCT/total)](https://github.com/misyaguziya/VRCT/releases) +[![Licence](https://img.shields.io/github/license/misyaguziya/VRCT)](https://github.com/misyaguziya/VRCT/blob/master/LICENSE) +[![Booth](https://img.shields.io/badge/Store-Booth.pm-red)](https://misyaguziya.booth.pm/items/5155325) +[![Github Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-30363D?&logo=GitHub-Sponsors&logoColor=EA4AAA)](https://github.com/sponsors/misyaguziya) + +

+Become a VRCT Supporter on: +

+ + + + + + PIXIV FANBOX + +   + + + + + + Patreon + +   + + + + Ko-fi + +   + +
+ + + + + Supporter Section Border + + +
+
+ +| **English** | [日本語](./README.ja.md) | [한국어](./README.ko.md) | [繁體中文](./README.zh-Hant.md) | + +

+VRCT is software that supports VRChat conversations with translation and transcription. +

+ +![](../img/main_window.png) + +
+ +# Download & Install +Download from anywhere you like. +- [Github.com](https://github.com/misyaguziya/VRCT/releases/) +- [BOOTH.pm](https://misyaguziya.booth.pm/items/5155325) + +Just download and run the exe. + +# What is VRCT? +VRCT is software that supports conversations between people who speak different languages by providing chat or voice translation. +These features are designed for use within VRChat. +*Although not supported, it is also used for other purposes such as watching movies. + +VRCT supports your conversations with +- 💬 **Send chat to VRChat** +- 🌐 **Translation** +- 🎙 **Transcription of audio from microphone** +- 🔈 **Transcription of audio from Speaker** + +# Documents +Initial setup, basic functions, and other features are also described. +- [Documents Link](https://mzsoftware.notion.site/VRCT-Documents-be79b7a165f64442ad8f326d86c22246?pvs=4) + +# How to Use (YouTube) +
+ +[![](https://img.youtube.com/vi/rUTad037n8Q/0.jpg)](https://www.youtube.com/watch?v=rUTad037n8Q) + +
+ +## Author +- [みしゃ(misyaguzi)](https://github.com/misyaguziya) (Main Development) +- [しいな(Shiina_12siy)](https://twitter.com/Shiina_12siy) (UI/UX, UI multilingual support) +- [レラ](https://github.com/soumt-r) (Technical Support) +- [どね](https://twitter.com/done_vrc) (Logo Design) + +## Thanks to our contributors + + + + +--- + +VRCT is not endorsed by VRChat and does not reflect the views or opinions of VRChat or anyone officially involved in producing or managing VRChat properties. VRChat and all associated properties are trademarks or registered trademarks of VRChat Inc. VRChat © VRChat Inc. \ No newline at end of file diff --git a/README.ja.md b/docs/readmes/README.ja.md similarity index 70% rename from README.ja.md rename to docs/readmes/README.ja.md index d89c95a6..e760bd7f 100644 --- a/README.ja.md +++ b/docs/readmes/README.ja.md @@ -1,9 +1,9 @@
- - - VRCT Logo + + + VRCT Logo
@@ -21,44 +21,44 @@ Become a VRCT Supporter on: - - - PIXIV FANBOX + + + PIXIV FANBOX    - - - Patreon + + + Patreon    - Ko-fi + Ko-fi   
- - - Supporter Section Border + + + Supporter Section Border

-| [English](./README.md) | **日本語** | [한국어](./README.ko.md) | [繁體中文](./README.zh-Hant.md) | +| [English](./README.en.md) | **日本語** | [한국어](./README.ko.md) | [繁體中文](./README.zh-Hant.md) |

VRCTは翻訳や文字起こしでVRChatの会話をサポートするソフトウェアです。

-![](docs/main_window.png) +![](../img/main_window.png)
diff --git a/README.ko.md b/docs/readmes/README.ko.md similarity index 70% rename from README.ko.md rename to docs/readmes/README.ko.md index bb260ba0..08498602 100644 --- a/README.ko.md +++ b/docs/readmes/README.ko.md @@ -1,9 +1,9 @@
- - - VRCT Logo + + + VRCT Logo
@@ -21,44 +21,44 @@ Become a VRCT Supporter on: - - - PIXIV FANBOX + + + PIXIV FANBOX    - - - Patreon + + + Patreon    - Ko-fi + Ko-fi   
- - - Supporter Section Border + + + Supporter Section Border

-| [English](./README.md) | [日本語](./README.ja.md) | **한국어** | [繁體中文](./README.zh-Hant.md) | +| [English](./README.en.md) | [日本語](./README.ja.md) | **한국어** | [繁體中文](./README.zh-Hant.md) |

VRCT는 음성인식 및 번역 기능을 통해 VRChat의 대화를 지원하는 소프트웨어입니다.

-![](docs/main_window.png) +![](../img/main_window.png)
diff --git a/README.zh-Hant.md b/docs/readmes/README.zh-Hant.md similarity index 67% rename from README.zh-Hant.md rename to docs/readmes/README.zh-Hant.md index e9535ceb..a4dae847 100644 --- a/README.zh-Hant.md +++ b/docs/readmes/README.zh-Hant.md @@ -1,9 +1,9 @@
- - - VRCT Logo + + + VRCT Logo
@@ -21,44 +21,44 @@ Become a VRCT Supporter on: - - - PIXIV FANBOX + + + PIXIV FANBOX    - - - Patreon + + + Patreon    - Ko-fi + Ko-fi   
- - - Supporter Section Border + + + Supporter Section Border

-| [English](./README.md) | [日本語](./README.ja.md) | [한국어](./README.ko.md) | **繁體中文** | +| [English](./README.en.md) | [日本語](./README.ja.md) | [한국어](./README.ko.md) | **繁體中文** |

VRCT 是一個支援 VRChat 對話翻譯和紀錄的軟體。

-![](docs/main_window.png) +![](../img/main_window.png)