crabmail

Static HTML email archive viewer in Rust
git clone git://git.alexwennerberg.com/crabmail
Log | Files | Refs | README | LICENSE

commit b43b66f08a07f3ecc02c3ab91e40051ec574aec3
parent 80dbd225892fb8da7ed8238ae641f735fc5be03d
Author: alex wennerberg <alex@alexwennerberg.com>
Date:   Sun, 26 Dec 2021 14:18:00 -0800

Change to plaintext README

Diffstat:
AREADME | 38++++++++++++++++++++++++++++++++++++++
DREADME.md | 35-----------------------------------
2 files changed, 38 insertions(+), 35 deletions(-)

diff --git a/README b/README @@ -0,0 +1,38 @@ +🦀Crabmail🦀 +=========== + +A static mail HTML archive for the 21st century, written in Rust. Includes +helpful "modern" features that existing solutions lack, like: + +* Responsive UI +* Single-page threads +* Working mailto: links +* Thread-based Atom feeds + +Not implemented yet / designed: +* Attachment handling? +* Gemini support + +EMAIL FOREVER! + +Install and usage +================= + +git clone https://git.alexwennerberg.com/crabmail/ +cd crabmail && cargo install --path . + +Copy crabmail.conf and set the variables as needed. + +Run crabmail [some-mbox-file.mbox] -c [config-file.conf]. + +Open site/index.html in a web browser + +For project discussion and patches, use the Mailing list: +https://lists.flounder.online/crabmail/ + +See the companion project, imap2mbox: +https://git.alexwennerberg.com/imap2mbox/ + +Crabmail is AGPLv3 licenses, but I'm happy to release code snippets from this +repo (which reimplements some common Rust functions) in a less permissive +license. Email me! diff --git a/README.md b/README.md @@ -1,35 +0,0 @@ -# 🦀Crabmail🦀 - -A static mail HTML archive for the 21st century, written in Rust. Includes -helpful "modern" features that existing solutions lack, like: - -* Responsive UI -* Single-page threads -* Working mailto: links -* Thread-based Atom feeds - -Not implemented yet / designed: -* Attachment handling? -* Gemini support - -EMAIL FOREVER! - -## Install and usage ``` git clone https://git.alexwennerberg.com/crabmail/ cd -crabmail && cargo install --path . ``` - -Copy `crabmail.conf` and set the variables as needed. Run `crabmail -[some-mbox-file.mbox] -c [config-file.conf]` Open `site/index.html` in a web -browser - -Try downloading the [gemini mailing list -archive](https://lists.orbitalfox.eu/archives/gemini/) for test data. - -For project discussion and patches, use the [Mailing -list](https://lists.flounder.online/crabmail/) - -See the companion project, -[imap2mbox](https://git.alexwennerberg.com/imap2mbox/) - -Crabmail is AGPLv3 licenses, but I'm happy to release code snippets from this -repo (which reimplements some common Rust funxtions) in a less permissive -license. Email me!