Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved Getting Started page for non-programmers #307

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/Quickstart/Hardware/hardware.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Hardware
# Hardware & OS

## Operating System

| System | Requirement |
| ------------- | -------------------------------------------------------------------------------------------- |
| `macOS` | High Sierra (10.13) or newer. Talon is a universal2 build with native Apple Silicon support. |
| `Linux / X11` | (Ubuntu 18.04+, and most modern distros), Wayland support is currently limited to XWayland |
| `Windows` | Windows 8 or newer |

## Microphones

Expand Down
76 changes: 58 additions & 18 deletions docs/Quickstart/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,84 @@ sidebar_position: 1

# Getting Started

:::note

You can also install and run Talon by following the [official installation instructions](https://talonvoice.com/docs/). This info supplements that page.
## 1: Check System Requirements

:::
Talon has various [system requirements](Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware.

## 1: [Download Talon](https://talonvoice.com/)
## 2: Download & Install Talon

<details>
<summary>Notes for Linux Users</summary>
- Talon, like many tools for automation or accessibility, __does not support Wayland__
<summary>Linux Users</summary>
- Download [Talon for Linux](https://talonvoice.com/dl/latest/talon-linux.tar.xz)
- Install by **To be completed**
:::note
- Talon, like many tools for automation or accessibility, __does not support Wayland__
- You will have to select an X11 session from your login manager.
- This is supported by Gnome and Plasma and many others, but some environments like sway are explicitly Wayland-only.
- To install the speech engine, you must use Talon's tray icon:
* If you use stock Gnome, you need to install [AppIndicator and KStatusNotifierItem Support](https://extensions.gnome.org/extension/615/appindicator-support/) to see it
* If you use i3 or a system tray that doesn't support the `StatusNotifierItem` protocol, install [snixembed](https://git.sr.ht/~steef/snixembed) to add support.
:::
</details>

<details>
<summary>Mac Users</summary>
- Download [Talon for Mac](https://talonvoice.com/dl/latest/talon-mac.dmg)
- Install by **To be completed**
</details>

<details>
<summary>Windows Users</summary>
- Download [Talon for Windows](https://talonvoice.com/dl/latest/talon-windows.exe)
- Install Talon by running `talon-windows.exe`
:::note
It is recommended that Talon is installed as described above.
However, please note that the application is also available as a [portable zip file](https://talonvoice.com/dl/latest/talon-windows.zip)
:::
</details>

## 2: Install a speech recognition engine
## 3: Install a speech recognition engine

Talon uses a local speech recognition engine that translates voice audio to text. To install your speech engine, click the Talon tray icon and select `Speech Recognition → Conformer D`. For other engine options, see the [speech engine page](./Speech%20Engines/speech%20engines.md)
Talon uses a local speech recognition engine that translates voice audio to text.

## 3: Install a Talon user file set
One recognition engine that comes with Talon is known as `Conformer D`. To install it:

Talon does not come with voice commands out of the box. To start, we strongly recommend that you use the [Talon Community](https://github.com/talonhub/community) user file set. The whole wiki assumes this repository is used if not otherwise noted.
- Run the Talon app
- Click the Talon tray icon and select `Speech Recognition → Conformer D`.

See the [Talon Community README](https://github.com/talonhub/community?tab=readme-ov-file#installation) for installation instructions.
<details>
<summary>Screenshot</summary>
<img src="/img/talon_menu_speech_recognition.png"
alt="screenshot of the Windows desktop showing the speech recognition menu"
/>
</details>

:::note
For other engine options, see the [speech engine page](./Speech%20Engines/speech%20engines.md)
:::

## 4: Install a Talon user file set

:::important
Talon does not come with voice commands out of the box. So at this point in the installation process,
Talon can not do anything useful.

It requires a `user file set` and
for beginners, we strongly recommend that you use the [Talon Community](https://github.com/talonhub/community) user file set.

In addition to [Talon Community](https://github.com/talonhub/community), you may want to consider installing any of the [essential Talon integrations](../Integrations/essential-tools.md)
The whole wiki assumes this repository is used if not otherwise noted.
:::

See the [Talon Community README](https://github.com/talonhub/community?tab=readme-ov-file#installation) for installation instructions.

## 4: Test your Talon Setup
## 5: Test your Talon Setup

- Try a few [basic commands](../Basic%20Usage/basic_usage.md).

## 6: Next steps

- If needed, try ways to [improve recognition accuracy](improving_recognition_accuracy.md)
- [Customize Talon](../Customization/basic_customization.md): learn about how to configure Talon to your liking.
- In addition to [Talon Community](https://github.com/talonhub/community), you may want to consider installing any of the [essential Talon integrations](../Integrations/essential-tools.md)
- If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
- For earlier access to new features, priority support, and access to additional [speech engines](./Speech%20Engines/speech%20engines.md), install the [beta version](beta_talon.md).

## Join the Talon Slack

If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
2 changes: 1 addition & 1 deletion docs/Quickstart/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ After you have started the Talon application, look for the Talon icon in the men
Talon's icon should show up in the menu bar in the upper right corner of your screen:
</p>
<img src="/img/talon_menubar_awake.png"
alt="screenshot of the desktop on a mac showint the talon icon in the top right menubar"
alt="screenshot of the desktop on a mac showing the talon icon in the top right menubar"
/>
</details>

Expand Down
Binary file added static/img/talon_menu_speech_recognition.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.