crabmail

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

commit a79e5d01c2bfa324d4b40e82349245f68f5d4230
parent 6206bd7a0af220b058e239b103cfbae13c39dda1
Author: alex wennerberg <alex@alexwennerberg.com>
Date:   Wed, 12 Jan 2022 17:44:59 -0800

update readme

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

diff --git a/README.md b/README.md @@ -26,7 +26,8 @@ cd crabmail && cargo install --path . Copy `crabmail.conf` and set the variables as needed. -Get a maildir folder, for example, via `mbsync`. Crabmail will create sub-lists for each folder inside this maildir. +Get a maildir folder, for example, via `mbsync`. Crabmail will create sub-lists +for each folder inside this maildir. Run crabmail [maildir root] -c [config-file.conf]. @@ -39,9 +40,10 @@ 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, and to see a live example, check out the [crabmail mailing list](https://lists.flounder.online/crabmail/) +For project discussion and patches, and to see a live example, check out the +[crabmail mailing list](https://lists.flounder.online/crabmail/) -Crabmail is AGPLv3 licenses, but some files are licensed under 0BSD. +Crabmail is AGPLv3 licenses, but some files are licensed under 0BSD or other +more permissive licenses. I call this out when I can. -See also -https://git.causal.agency/bubger/about/ +For a similar project, check out [bubger](https://git.causal.agency/bubger/about/)