aerc/README.md

47 lines
1.2 KiB
Markdown
Raw Normal View History

# aerc
2019-05-25 21:58:40 +02:00
aerc is an email client for your terminal.
2019-05-14 20:47:46 +02:00
Join the IRC channel: [#aerc on irc.freenode.net](http://webchat.freenode.net/?channels=aerc&uio=d4)
2019-07-14 19:53:09 +02:00
for end-user support, and [#aerc-dev](http://webchat.freenode.net/?channels=aerc-dev&uio=d4)
for development.
2019-05-14 20:47:46 +02:00
## Building
2019-05-25 21:55:50 +02:00
Install the dependencies:
2019-05-18 00:15:50 +02:00
- go (>=1.12)
2020-02-02 07:13:59 +01:00
- [scdoc](https://git.sr.ht/~sircmpwn/scdoc)
2019-05-18 00:15:50 +02:00
2019-05-25 21:55:50 +02:00
Then compile aerc:
2019-05-17 19:45:20 +02:00
$ make
2019-08-05 09:16:10 +02:00
aerc optionally supports notmuch. To enable it, you need to have a recent
version of [notmuch](https://notmuchmail.org/#index7h2), including the header
files (notmuch.h). Then compile aerc with the necessary build tags:
$ GOFLAGS=-tags=notmuch make
2019-05-17 19:45:20 +02:00
## Installation
# make install
2019-05-25 21:58:40 +02:00
$ aerc
2019-03-22 03:07:03 +01:00
2019-05-25 21:58:40 +02:00
On its first run, aerc will copy the default config files to `~/.config/aerc`
and show the account configuration wizard.
If you redirect stdout to a file, logging output will be written to that file:
$ aerc > log
2019-05-26 18:00:51 +02:00
## Resources
2019-05-26 18:00:51 +02:00
[Send patches](https://git-send-email.io) and questions to
[~sircmpwn/aerc@lists.sr.ht](https://lists.sr.ht/~sircmpwn/aerc).
Subscribe to release announcements on
[~sircmpwn/aerc-announce](https://lists.sr.ht/~sircmpwn/aerc-announce)
2019-03-17 22:47:35 +01:00
Bugs & todo here: [~sircmpwn/aerc2](https://todo.sr.ht/~sircmpwn/aerc2)