aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorB. Stack <bgstack15@gmail.com>2024-09-24 16:11:26 -0400
committerB. Stack <bgstack15@gmail.com>2024-09-24 16:11:26 -0400
commitf5390f91104ca5c531a1e778ecfafadc0a668075 (patch)
tree8844dcc45c58483090f10aa55cf7acb89ce6fe26 /README.md
parentadd advanced pane which lets you control other users (diff)
downloadfprintd-tk-f5390f91104ca5c531a1e778ecfafadc0a668075.tar.gz
fprintd-tk-f5390f91104ca5c531a1e778ecfafadc0a668075.tar.bz2
fprintd-tk-f5390f91104ca5c531a1e778ecfafadc0a668075.zip
add verbose, advanced (control other users), docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e60cbfb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# README for fprintd_tk
+This project is a desktop application that makes it easy for a user to control fingerprint enrollments.
+
+## Upstream
+The upstream project is hosted at <https://bgstack15.ddns.net/cgit/fprintd_tk>
+
+## Alternatives
+
+* Use `fprintd-enroll` on cli.
+* Use whatever probably-GNOME software is demonstrated in <https://wiki.debian.org/SecurityManagement/fingerprint%20authentication>
+
+## Reason for existence
+I couldn't find a window-manager friendly gui for managing fingerprints.
+
+## Using
+Run the program.
+
+## Dependencies
+
+* [python-tkstackrpms](https://bgstack15.ddns.net/cgit/python3-tkstackrpms/)
+* python3-tk
+* python3-pil
+
+The application really needs the user to have password-less auth permission in dbus/polkit to the fprintd actions. You will want a file like [80-fprintd.rules](aux/80-fprintd.rules)
+
+## Building
+
+## References
+
+* Icons adapted from [Numix Circle icon theme](https://github.com/numixproject/numix-icon-theme-circle) under GPL 3.0
bgstack15