crabmail

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

commit f2e89cf3ff1d0c31d2ab3dbad18a06ffb00b204c
parent 5b617781dd26f53b34580a76a80d2fe41de3799e
Author: alex wennerberg <alex@alexwennerberg.com>
Date:   Thu,  6 Jan 2022 21:13:52 -0800

rename README

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

diff --git a/README b/README @@ -1,41 +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 -================= - -(DRAFT) see https://alex.flounder.online/tech/howtolist.gmi for more detail - -git clone https://git.alexwennerberg.com/crabmail/ -cd crabmail && cargo install --path . - -Copy crabmail.conf and set the variables as needed. - -Run crabmail [maildir root] -c [config-file.conf]. - -If you want to use an mbox, use https://github.com/leahneukirchen/mblaze to -import it into a maildir. Mblaze also has some tools that you may find -supplementary to crabmail. - -Open site/index.html in a web browser - -For project discussion and patches, use the Mailing list: -https://lists.flounder.online/crabmail/ - -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 @@ -0,0 +1,39 @@ +# 🦀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 + +(DRAFT) see https://alex.flounder.online/tech/howtolist.gmi for more detail + +git clone https://git.alexwennerberg.com/crabmail/ +cd crabmail && cargo install --path . + +Copy crabmail.conf and set the variables as needed. + +Run crabmail [maildir root] -c [config-file.conf]. + +If you want to use an mbox, use https://github.com/leahneukirchen/mblaze to +import it into a maildir. Mblaze also has some tools that you may find +supplementary to crabmail. + +Open site/index.html in a web browser + +For project discussion and patches, use the Mailing list: +https://lists.flounder.online/crabmail/ + +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!