summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorpommicket <pommicket@gmail.com>2025-02-25 22:48:04 -0500
committerpommicket <pommicket@gmail.com>2025-02-25 22:48:04 -0500
commit753651a2c21b5e7fc6725560ffdd5d4c01732359 (patch)
tree7f74f8774022a0388f8b234da3b81439ba5c28fc /README.md
parentb88b34dbd672ac2b58d4f7c12f96fa79337cfe1f (diff)
switch back to SDL for audio capture
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 18 insertions, 5 deletions
diff --git a/README.md b/README.md
index ac96955..58057e5 100644
--- a/README.md
+++ b/README.md
@@ -8,12 +8,14 @@ It features
- Full selection of resolutions available from camera
- Remembers settings across program launches
-# Debugging
+# Usage
-If you find a bug, please create an issue on GitHub; it will be helpful to have
-your settings and log file, located in `~/.config/camlet`.
-
-You can try deleting/renaming your settings file as a temporary solution, to reset camlet to its default settings.
+- <kbd>F1</kbd> - show this help text
+- <kbd>F2</kbd> - show debug info
+- <kbd>Space</kbd> - take a picture or start/stop recording video
+- <kbd>Escape</kbd> - open/close settings
+- <kbd>Ctrl</kbd>+<kbd>f</kbd> - open picture directory
+- <kbd>Tab</kbd> - switch between picture and video
# Building from source
@@ -30,3 +32,14 @@ You can build the debug version of camlet with `make` (outputs `camlet.debug`),
version with `make release` (outputs `release/camlet`), and install it with
`make install`, or e.g. `INSTALL_PREFIX=~/.local make install` to customize the installation directory (default: `/usr/local`).
You can also build the .deb installer with `make camlet.deb`.
+
+# Debugging
+
+- Known issue: pulseaudio audio capturing is broken on some versions of SDL2
+ https://github.com/libsdl-org/SDL/issues/9706. This bug has been fixed now, so hopefully
+ it will make it to your computer soon.
+
+If you find a bug, please create an issue on GitHub; it will be helpful to have
+your settings and log file, located in `~/.config/camlet`.
+
+You can try deleting/renaming your settings file as a temporary solution, to reset camlet to its default settings.