crabmail

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

commit 9c315c6a8ad02f7b0b9fe84eaa23ab10aeb51623
parent 994b9bb0d794786fb4209d3842fdb372d5f3a607
Author: alex wennerberg <alex@alexwennerberg.com>
Date:   Sat, 25 Dec 2021 15:31:58 -0800

word wrap readme

Diffstat:
MREADME.md | 25+++++++++++++------------
1 file changed, 13 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md @@ -1,6 +1,7 @@ # 🦀Crabmail🦀 -A static mail HTML archive for the 21st century, written in Rust. Includes helpful "modern" features that existing solutions lack, like: +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 @@ -13,21 +14,21 @@ Not implemented yet / designed: EMAIL FOREVER! -## Install and usage -``` -git clone https://git.alexwennerberg.com/crabmail/ -cd crabmail && cargo install --path . -``` +## 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 +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. +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/) +For project discussion and patches, use the [Mailing +list](https://lists.flounder.online/crabmail/) -See the companion project, [imap2mbox](https://git.alexwennerberg.com/imap2mbox/) +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