summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authoryum <yum.food.vr@gmail.com>2022-12-22 13:47:40 -0800
committeryum <yum.food.vr@gmail.com>2022-12-22 13:47:40 -0800
commit9c6b3c43ddecca315cdba11ebd14f6926527fa8b (patch)
tree2e4ff20e65cc77e266d16f3d1a23d4c0b2520e50 /README.md
parent02a1cfb67bbd67bbaca53de77ce3aad97648427b (diff)
Update README.mdv0.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 25 insertions, 26 deletions
diff --git a/README.md b/README.md
index c78037b..98a900a 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,31 @@ custom shader display the text in game.
![Speech-to-text demo](Images/speech_to_text_demo.gif)
-Features:
+Contents:
+0. [Usage and setup](#usage-and-setup)
+1. [Features](#features)
+2. [Motivation](#motivation)
+3. [Design overview](#design-overview)
+4. [Contributing](#contributing)
+5. [Backlog](#backlog)
+
+Made with love by yum\_food.
+
+## Usage and setup
+
+To use a prebuilt package, go to the releases tab and download the latest
+release. Follow the guide associated with that release. To give you a taste,
+[here's the v0.0 setup guide](https://www.youtube.com/watch?v=0qjxkdVTqcs).
+
+To build your own package from source, see GUI/README.md.
+
+Basic controls:
+* Short click the left joystick to make it show up & start transcribing.
+* Short click the left joystick to make it lock in place & stop transcribing.
+* Long click the left joystick to make it go away & stop transcribing.
+* Scale it up/down in the radial menu.
+
+## Features
* 4x48 grid, 256 or 65536 characters per slot.
* Text-to-text interface.
@@ -32,14 +56,6 @@ Features:
* 100% from-scratch implementation.
* Permissive MIT license.
-Contents:
-1. [Motivation](#motivation)
-2. [Design overview](#design-overview)
-3. [Contributing](#contributing)
-4. [Backlog](#backlog)
-
-Made with love by yum\_food.
-
### Motivation
Many VRChat players choose not to use their mics, but as a practical matter,
@@ -128,23 +144,6 @@ character set:
Contributions welcome. Send a pull request to this repository.
-To use the STT:
-
-1. Enable Windows Subsystem for Linux. This is a lightweight Linux virtual
- machine that runs on your Windows host. You can access the Windows
- filesystem at /mnt/c/....
-2. `$ cd /mnt/c/path/to/your/unity/project`
-2. `$ cd Assets`
-3. `$ git clone https://github.com/yum\_food/TaSTT`
-4. `$ cd TaSTT`
-5. `$ ./generate.sh`
-6. Put TaSTT\_fx.controller and TaSTT\_params.asset on your avatar.
-7. Upload (or build & test).
-8. Open powershell.
-9. Navigate to TaSTT.
-10. `$ python3 ./osc_ctrl.py`
-11. Start typing. Your messages should show display in-game.
-
### Backlog
1. Better Unity integrations