talons

Fork of Claws Mail https://www.claws-mail
Log | Files | Refs | README | LICENSE

README.md (1341B)

      1 # Talons
      2 
      3 Talons is a GTK3 email client
      4 supporting managing mailboxes via IMAP and on a filesystem.
      5 
      6 Talons is a fork of [Claws Mail],
      7 which itself is a fork of [Sylpheed].
      8 It started out life as an experiment of using [Zig] to maintain an old C codebase.
      9 
     10 OpenBSD is supported; other OSs untested.
     11 
     12 ## Getting started
     13 
     14 Talons has direct dependencies on the following libraries:
     15 
     16 - cairo
     17 - gdk-3
     18 - gdk_pixbuf-2.0
     19 - gio-2.0
     20 - glib-2.0
     21 - gmp
     22 - gnutls
     23 - gtk-3
     24 - hogweed
     25 - libidn2
     26 - nettle
     27 - p11-kit
     28 - pango-1.0
     29 - tasn1
     30 - unistring
     31 
     32 Install these using pkg_add(1).
     33 
     34 TODO symlink workarounds for https://github.com/ziglang/zig/pull/18475
     35 
     36 Install zig (`pkg_add zig`) then build the project:
     37 
     38 	cd src
     39 	zig build
     40 
     41 To run the app:
     42 
     43 	zig build run
     44 
     45 ## Goals
     46 
     47 Many features of Claws Mail have been removed to make it easier to maintain by a single person.
     48 As of the end of 2025, Talons is less than half the size of Claws Mail; 120KLOC. versus Claws Mail 4.3.1 at around 295KLOC.
     49 
     50 To be honest I can't even remember how many or which features have been removed.
     51 Off the top of my head:
     52 
     53 - no autotools
     54 - no Windows support
     55 - no plugins
     56 - no localisation (sorry)
     57 - no actions
     58 - no client-side mail filtering
     59 - no LDAP, Palm Pilot address books
     60 
     61 [Zig]: https://ziglang.org
     62 [Claws Mail]: https://claws-mail.org
     63 [Sylpheed]: https://sylpheed.sraoss.jp/en/