aboutsummaryrefslogtreecommitdiffstats
path: root/qtmaildir/README
diff options
context:
space:
mode:
Diffstat (limited to 'qtmaildir/README')
-rw-r--r--qtmaildir/README29
1 files changed, 29 insertions, 0 deletions
diff --git a/qtmaildir/README b/qtmaildir/README
new file mode 100644
index 0000000..3e4f387
--- /dev/null
+++ b/qtmaildir/README
@@ -0,0 +1,29 @@
+qtmaildir is a Qt6 desktop client for reading and organizing a local
+Maildir that notmuch has indexed. It is a GUI counterpart to neomutt for
+the parts of mail handling that are easier with a mouse and a real HTML
+renderer.
+
+It does no network protocol work at all: there is no POP, IMAP or SMTP,
+and no sync implementation. Mail arrives in your Maildir by whatever you
+already use (mbsync, offlineimap, fetchmail) and is indexed by
+'notmuch new'. Fetching is delegated to a command you configure, so it
+joins the lock that already serializes your script against cron rather
+than running a second mbsync over the same Maildir. Sending is not
+implemented.
+
+You need a working notmuch database before qtmaildir is useful; it does
+not create or configure one. The Maildir path is deliberately not
+configurable, since notmuch already stores it as database.path.
+
+Qt6 (including WebEngine), gmime and cmake are part of Slackware, so
+notmuch is the only dependency that is not.
+
+The interface follows your locale where a translation exists, and an
+Italian one ships. Set 'language' under [general] to override it.
+
+Configuration lives at ~/.config/qtmaildir/qtmaildir.conf and is
+documented in /usr/doc/qtmaildir-$VERSION/README.md.
+
+This package is built with the test suite disabled
+(-DQTMAILDIR_BUILD_TESTS=OFF), which skips the Qt6::Test dependency and
+builds nothing that would ship.