From 24362420179d09761ba814d32e29055a9b0d1b91 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 4 Nov 2022 10:33:08 +1100 Subject: [PATCH] readme: move recording an input tools into their own dot-points This was getting difficult to follow. --- readme.rst | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/readme.rst b/readme.rst index b42ba52..b640993 100644 --- a/readme.rst +++ b/readme.rst @@ -67,14 +67,29 @@ Dependencies - Python 3. - The VOSK-API. -- ``parec`` command for recording from pulse-audio (default) or - ``sox`` command as alternative. - See the guide: `Using sox with nerd-dictation `_. -- `xdotool `_ command to simulate input in X11 (default) or - `dotool `_ command to simulate input anywhere (X11/Wayland/TTYs) or - `ydotool `_ similar to dotool but requires setup and a daemon to be running - (see the setup guide: `Using ydotool with nerd-dictation `_) - or `wtype `_ an "xdotool for wayland" +- An audio recording utility (``parec`` by default). +- An input simulation utility (``xdotool`` by default). + + +Audio Recording Utilities +------------------------- + +You may select one of the following tools. + +- ``parec`` command for recording from pulse-audio. +- ``sox`` command as alternative, see the guide: `Using sox with nerd-dictation `_. + + +Input Simulation Utilities +-------------------------- + +You may select one of the following input simulation utilities. + +- `xdotool `__ command to simulate input in X11. +- `ydotool `__ command to simulate input anywhere (X11/Wayland/TTYs) + (see the setup guide: `Using ydotool with nerd-dictation `_). +- `dotool `__ command to simulate input anywhere (X11/Wayland/TTYs). +- `wtype `__ to simulate input in Wayland". Install