Skip to content

Commit

Permalink
readme: move recording an input tools into their own dot-points
Browse files Browse the repository at this point in the history
This was getting difficult to follow.
  • Loading branch information
ideasman42 committed Nov 3, 2022
1 parent b267f0c commit 2436242
Showing 1 changed file with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <readme-sox.rst>`_.
- `xdotool <https://github.com/jordansissel/xdotool>`_ command to simulate input in X11 (default) or
`dotool <https://git.sr.ht/~geb/dotool>`_ command to simulate input anywhere (X11/Wayland/TTYs) or
`ydotool <https://github.com/ReimuNotMoe/ydotool>`_ similar to dotool but requires setup and a daemon to be running
(see the setup guide: `Using ydotool with nerd-dictation <readme-ydotool.rst>`_)
or `wtype <https://github.com/atx/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 <readme-sox.rst>`_.


Input Simulation Utilities
--------------------------

You may select one of the following input simulation utilities.

- `xdotool <https://github.com/jordansissel/xdotool>`__ command to simulate input in X11.
- `ydotool <https://github.com/ReimuNotMoe/ydotool>`__ command to simulate input anywhere (X11/Wayland/TTYs)
(see the setup guide: `Using ydotool with nerd-dictation <readme-ydotool.rst>`_).
- `dotool <https://git.sr.ht/~geb/dotool>`__ command to simulate input anywhere (X11/Wayland/TTYs).
- `wtype <https://github.com/atx/wtype>`__ to simulate input in Wayland".


Install
Expand Down

0 comments on commit 2436242

Please sign in to comment.