From b88b34dbd672ac2b58d4f7c12f96fa79337cfe1f Mon Sep 17 00:00:00 2001
From: pommicket <pommicket@gmail.com>
Date: Tue, 25 Feb 2025 22:19:37 -0500
Subject: start work on application

---
 README.md | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index de93934..ac96955 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,20 @@
 # camlet
 
-Camlet is a picture-taking application for Linux.
+Camlet is a webcam application for Linux.
 It features
 
-- Reasonably good performance
-- Proper handling of disconnecting/reconnecting devices, including the ability to prioritize some cameras over others
-- JPEG and PNG output
+- Proper handling of disconnecting/reconnecting devices
+- Capture JPEG and PNG images and MP4 (H264+AAC) videos
 - Full selection of resolutions available from camera
 - Remembers settings across program launches
 
+# Debugging
+
+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.
+
 # Building from source
 
 camlet requires meson-build, a C compiler, and the development libraries
@@ -19,3 +25,8 @@ These can all be installed on Debian/Ubuntu with
 ```sh
 sudo apt install clang meson libv4l-dev libudev-dev libsodium-dev libfontconfig-dev libgl-dev libsdl2-dev libsdl2-ttf-dev libjpeg-dev libpulse-dev libavcodec-dev libavformat-dev
 ```
+
+You can build the debug version of camlet with `make` (outputs `camlet.debug`), the release
+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`.
-- 
cgit v1.2.3