commit 20c89304775710f5da2c4e6ea4c2a1951e1f8e72 parent f05eae35fae254042dd41fb9505cc90bda96e316 Author: alex wennerberg <alex@alexwennerberg.com> Date: Fri, 24 Dec 2021 14:49:51 -0800 Add instructions to readme Diffstat:
| M | README.md | | | 13 | +++++++++++++ |
1 file changed, 13 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -9,9 +9,22 @@ A static mail HTML archive for the 21st century, written in Rust. Includes helpf 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/)