From 53453300beac098ac79ca78294515f9fe9743617 Mon Sep 17 00:00:00 2001 From: pommicket Date: Wed, 26 Feb 2025 11:52:50 -0500 Subject: Update README --- README.md | 40 +++++++++++++++++++++++++++++++++------- control.sh | 2 +- 2 files changed, 34 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 58057e5..2530caf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # camlet + + Camlet is a webcam application for Linux. It features @@ -8,7 +10,20 @@ It features - Full selection of resolutions available from camera - Remembers settings across program launches -# Usage +## Installation + +You can find .deb installers on the [releases page on GitHub](https://github.com/pommicket/camlet/releases). +If you want automatic updates, you can also +[add my repository to apt](https://s.pommicket.com/deb/), and just do + +```sh +sudo apt install camlet +``` + +If you are on a non-Debian-based Linux +distribution, you will have to build from source (see instructions below). + +## Usage - F1 - show this help text - F2 - show debug info @@ -17,15 +32,15 @@ It features - Ctrl+f - open picture directory - Tab - switch between picture and video -# Building from source +## Building from source camlet requires meson-build, a C compiler, and the development libraries -for SDL2, SDL2\_ttf, GL (headers only), v4l2, udev, sodium, jpeglib (from IJG), avcodec, avformat, pulseaudio, and fontconfig. +for SDL2, SDL2\_ttf, GL (headers only), v4l2, udev, sodium, jpeglib (from IJG), avcodec, avformat, and fontconfig. 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 +sudo apt install clang meson libv4l-dev libudev-dev libsodium-dev libfontconfig-dev libgl-dev libsdl2-dev libsdl2-ttf-dev libjpeg-dev libavcodec-dev libavformat-dev ``` You can build the debug version of camlet with `make` (outputs `camlet.debug`), the release @@ -33,13 +48,24 @@ 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 +## Debugging -- Known issue: pulseaudio audio capturing is broken on some versions of SDL2 +- Known issue: pulseaudio audio capturing is broken on some versions of SDL2.30: https://github.com/libsdl-org/SDL/issues/9706. This bug has been fixed now, so hopefully - it will make it to your computer soon. + the fix 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. + +## Version history + + + + +
Version Description Date
0.0.0 Initial release 2025 Feb 26
+ +## License + +0BSD diff --git a/control.sh b/control.sh index 11ac0b7..969dcc7 100755 --- a/control.sh +++ b/control.sh @@ -11,7 +11,7 @@ Architecture: amd64 Essential: no Maintainer: pommicket Description: Take pictures and videos with a webcam -Depends: libsdl2-2.0-0, libv4l-0, libudev1, libsodium23, libfontconfig1, libsdl2-ttf-2.0-0, libjpeg62-turbo, libavcodec59 | libavcodec61, libavformat59 | libavformat61 +Depends: libsdl2-2.0-0 | libsdl2-dev, libv4l-0 | libv4l-dev, libudev1 | libudev-dev, libsodium23 | libsodium-dev, libfontconfig1 | libfontconfig-dev, libsdl2-ttf-2.0-0 | libsdl2-ttf-dev, libjpeg62-turbo | libjpeg-dev, libavcodec59 | libavcodec61 | libavcodec-dev, libavformat59 | libavformat61 | libavformat-dev Homepage: https://github.com/pommicket/camlet EOF echo 'Installed-Size: '$(wc -c release/camlet camlet.png camlet.desktop | tail -n1 | cut -d' ' -f1 || exit 1) -- cgit v1.2.3