From aab19262d24ade9e5af9d3c94cc24aa715f9db47 Mon Sep 17 00:00:00 2001 From: Robin Jarry Date: Wed, 23 Mar 2022 20:44:24 +0100 Subject: readme: add links to documentation Let's make it easier for new users to find information. Signed-off-by: Robin Jarry Reviewed-by: Moritz Poldrack --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8b346ebe..0a98e619 100644 --- a/README.md +++ b/README.md @@ -23,12 +23,29 @@ If you redirect stdout to a file, logging output will be written to that file: $ aerc > log -For instructions and documentation: see `man aerc` and further specific man -pages on there. - Note that the example HTML filter (off by default), additionally needs `w3m` and `dante` to be installed. +### Documentation + +Also available as man pages: + +- [aerc(1)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc.1.scd) +- [aerc-config(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-config.5.scd) +- [aerc-imap(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-imap.5.scd) +- [aerc-maildir(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-maildir.5.scd) +- [aerc-notmuch(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-notmuch.5.scd) +- [aerc-search(1)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-search.1.scd) +- [aerc-sendmail(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-sendmail.5.scd) +- [aerc-smtp(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-smtp.5.scd) +- [aerc-stylesets(7)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-stylesets.7.scd) +- [aerc-templates(7)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-templates.7.scd) +- [aerc-tutorial(7)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-tutorial.7.scd) + +User contributions and integration with external tools: + +- [wiki](https://man.sr.ht/~rjarry/aerc/) + ## Installation ### Binary Packages -- cgit