Files
margin-mail/README.md
T
pj eb59cb5f8d build the app, and ship it on Linux and Windows as well as macOS
The client itself: the sync engine and mirror, the Gmail and IMAP providers,
the screener, the three boxes and two piles, compose and send, the sanitiser
and tracker stripping, contacts, clips, backup, notifications and the guide.

The pipeline that ships it. Three runners now build in parallel and the
publish gate wants all four platform keys in latest.json before a release
leaves draft. Linux gets two more packages Tauri does not build: a flatpak
repackaged from the deb against GNOME 48, and a Nix package that relinks the
deb against nixpkgs so it runs as a native Wayland client rather than through
Xwayland. CI runs the Rust suite on all three desktops rather than on Linux
alone, and rebuilds the flatpak manifest on every push to main.

Two things that were only ever exercised on macOS and were wrong everywhere
else. The menu bar was built by adjusting the submenus macOS is given, so on
a platform whose default menu has no File or View the new File menu landed
after Edit, Check for Updates landed nowhere, and the three places and the
reading pane had no menu at all. The deb declared libwebkit2gtk-4.1-0 and
libgtk-3-0 twice, because tauri.conf.json named the dependencies Tauri
already emits.

The updater key exists now, so releases can sign their artifacts.
2026-09-06 12:15:30 +05:30

21 lines
1.3 KiB
Markdown

# Margin Mail
A calm, keyboard-first mail client for Gmail on macOS, Linux, Windows and iPhone, with the parts of HEY and
Superhuman worth having and none of the tracking. New senders wait at the door until you let them
in; people, newsletters and receipts live in three separate boxes; what you owe and what you need
sit in two piles at the foot of the list. Every decision you make is yours, kept beside the mail
rather than inside Gmail, and it comes with you if you leave. It is a sibling to
[margin](https://github.com/priyanshujain/margin) and
[Margin Calendar](https://github.com/priyanshujain/margin-calendar) and shares their stack and
visual language.
The product is defined in [docs/design.md](docs/design.md), the features in
[docs/features.md](docs/features.md), the screens in [docs/ui.md](docs/ui.md), the keys in
[docs/keyboard.md](docs/keyboard.md) and the settings in [docs/settings.md](docs/settings.md). How
it gets built is [docs/architecture.md](docs/architecture.md) and [docs/plan.md](docs/plan.md), how
it ships is [docs/release.md](docs/release.md), and the research it rests on is in
[docs/research/](docs/research/). To install it, [docs/install.md](docs/install.md).
Licensed FSL-1.1-MIT: use it for anything except building a competing product, and every version
turns MIT two years after its release.