|
1 | 1 | ---
|
2 |
| -sidebar_position: 1 |
| 2 | +sidebar_position: 1.1 |
3 | 3 | ---
|
4 | 4 |
|
5 |
| -# Getting Started |
| 5 | +# Installation Guide |
6 | 6 |
|
| 7 | +:::docoscope Talon Platform |
| 8 | + |
| 9 | +Although much of this page is pertinent to the talon platform itself, |
| 10 | +some steps are specific to the talon community user file set, and will be marked as such. |
| 11 | + |
| 12 | +::: |
| 13 | + |
| 14 | +## 1: Check System Requirements |
| 15 | + |
| 16 | +Talon has various [system requirements](../Resource%20Hub/Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware. |
| 17 | + |
| 18 | +## 2: Download & Install Talon |
| 19 | + |
| 20 | +<details> |
| 21 | + <summary>Linux Users</summary> |
| 22 | + - Download [Talon for Linux](https://talonvoice.com) |
| 23 | + - Install by **To be completed** |
7 | 24 | :::note
|
8 | 25 |
|
9 |
| -You can also install and run Talon by following the [official installation instructions](https://talonvoice.com/docs/). This info supplements that page. |
| 26 | +- Talon, like many tools for automation or accessibility, **does not support Wayland** |
| 27 | + - You will have to select an X11 session from your login manager. |
| 28 | + - This is supported by Gnome and Plasma and many others, but some environments like sway are explicitly Wayland-only. |
| 29 | +- To install the speech engine, you must use Talon's tray icon: |
| 30 | + - If you use stock Gnome, you need to install [AppIndicator and KStatusNotifierItem Support](https://extensions.gnome.org/extension/615/appindicator-support/) to see it |
| 31 | + - 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. |
10 | 32 |
|
11 | 33 | :::
|
12 | 34 |
|
13 |
| -## 1: [Download Talon](https://talonvoice.com/) |
| 35 | +</details> |
14 | 36 |
|
15 | 37 | <details>
|
16 |
| - <summary>Notes for Linux Users</summary> |
17 |
| - - Talon, like many tools for automation or accessibility, __does not support Wayland__ |
18 |
| - - You will have to select an X11 session from your login manager. |
19 |
| - - This is supported by Gnome and Plasma and many others, but some environments like sway are explicitly Wayland-only. |
20 |
| -- To install the speech engine, you must use Talon's tray icon: |
21 |
| - * If you use stock Gnome, you need to install [AppIndicator and KStatusNotifierItem Support](https://extensions.gnome.org/extension/615/appindicator-support/) to see it |
22 |
| - * 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. |
| 38 | + <summary>Mac Users</summary> |
| 39 | + - Download [Talon for Mac](https://talonvoice.com) |
| 40 | + - Install by **To be completed** |
| 41 | +</details> |
23 | 42 |
|
| 43 | +<details> |
| 44 | + <summary>Windows Users</summary> |
| 45 | + - Download [Talon for Windows](https://talonvoice.com) |
| 46 | + - Install Talon by running `talon-windows.exe` |
| 47 | +:::note |
| 48 | +It is recommended that Talon is installed as described above. |
| 49 | +However, please note that the application is also available as a [portable zip file](https://talonvoice.com/dl/latest/talon-windows.zip) |
| 50 | +::: |
24 | 51 | </details>
|
25 | 52 |
|
26 |
| -## 2: Install a speech recognition engine |
| 53 | +## 3: Install a speech recognition engine |
| 54 | + |
| 55 | +Talon uses a local speech recognition engine that translates voice audio to text. |
| 56 | + |
| 57 | +One recognition engine that comes with Talon is known as `Conformer D`. To install it: |
| 58 | + |
| 59 | +- Run the Talon app |
| 60 | +- Click the Talon tray icon and select `Speech Recognition → Conformer D`. |
| 61 | + |
| 62 | +<details> |
| 63 | + <summary>Screenshot</summary> |
| 64 | +<img src="/img/talon_ui/talon_menu_speech_recognition_conformer.png" |
| 65 | + alt="screenshot of the Windows desktop showing the speech recognition menu" |
| 66 | + /> |
| 67 | +</details> |
| 68 | + |
| 69 | +:::note |
| 70 | +For other engine options, see the [speech engine page](/docs/Resource%20Hub/Speech%20Recognition/speech%20engines.md) |
| 71 | +::: |
| 72 | + |
| 73 | +## 4: Download the Talon user file set |
| 74 | + |
| 75 | +:::important |
| 76 | +Talon does not come with voice commands out of the box. So at this point in the installation process, |
| 77 | +Talon can not do anything useful. |
| 78 | + |
| 79 | +It requires a `user file set` and |
| 80 | +for beginners, we strongly recommend that you use the [Talon Community](https://github.com/talonhub/community) user file set. |
| 81 | + |
| 82 | +If you install a different user file set then portions of this wiki will not be relevant. |
| 83 | +These will be marked as such. |
| 84 | +::: |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +A `user file set` is simply a bunch of files that need to be downloaded and placed in the correct directory - |
| 90 | +the talon user directory. |
| 91 | +<!-- Update in later phase of https://github.com/TalonCommunity/Wiki/pull/312 |
| 92 | +the [talon user directory](/docs/Resource%20Hub/terminology). |
| 93 | +--> |
| 94 | + |
| 95 | +:::docoscope community |
| 96 | + |
| 97 | +::: |
| 98 | + |
| 99 | +This can be done one of two ways - either as a `zip` file or by using `git`. |
| 100 | +Considerations in choosing between the two methods, as well as instructions, are described [here](../Resource%20Hub/Talon%20Installation/downloading-community). |
27 | 101 |
|
28 |
| -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) |
| 102 | +## 5: Test your Talon Setup |
29 | 103 |
|
30 |
| -## 3: Install a Talon user file set |
| 104 | +If you have installed talon community, try a few [basic commands](/docs/Basic%20Usage/basic_usage.md). |
31 | 105 |
|
32 |
| -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. |
| 106 | +If you have installed a different user file set, consult its documentation on usage. |
33 | 107 |
|
34 |
| -See the [Talon Community README](https://github.com/talonhub/community?tab=readme-ov-file#installation) for installation instructions. |
| 108 | +## 6: Next steps |
35 | 109 |
|
36 |
| -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) |
37 | 110 |
|
38 |
| -## 4: Test your Talon Setup |
| 111 | +- If needed, try ways to [improve recognition accuracy](../Resource%20Hub/Speech%20Recognition/improving_recognition_accuracy.md) |
| 112 | +- [Customize Talon](../Customization/basic_customization): learn about how to configure Talon to your liking. |
| 113 | + - 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. |
| 114 | +- For earlier access to new features, priority support, and access to additional [speech engines](/docs/Resource%20Hub/Speech%20Recognition/speech%20engines.md), install the [beta version](../Help/beta_talon). |
39 | 115 |
|
40 |
| -- Try a few [basic commands](../Basic%20Usage/basic_usage.md). |
41 |
| -- If needed, try ways to [improve recognition accuracy](improving_recognition_accuracy.md) |
42 |
| -- [Customize Talon](../Customization/basic_customization.md): learn about how to configure Talon to your liking. |
43 |
| -- 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). |
| 116 | +<!-- Update in later phase of https://github.com/TalonCommunity/Wiki/pull/312 |
| 117 | +- If needed, try ways to [improve recognition accuracy](/docs/Resource%20Hub/Speech%20Recognition/improving_recognition_accuracy) |
| 118 | + --> |
44 | 119 |
|
45 |
| -## Join the Talon Slack |
| 120 | +<!-- Update in later phase of https://github.com/TalonCommunity/Wiki/pull/312 |
| 121 | +- In addition to [Talon Community](https://github.com/talonhub/community), you may want to consider installing any of the popular [Talon integrations](/docs/Integrations/integrations.md) |
| 122 | + --> |
46 | 123 |
|
47 |
| -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. |
|
0 commit comments