aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: af612fda21333b1b6e2c271b36f9d28143c49a1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# aerc

aerc is an email client for your terminal.

Join the IRC channel: [#aerc on irc.freenode.net](http://webchat.freenode.net/?channels=aerc&uio=d4)

## Building

Install the dependencies:

- go (compile-time)
- scdoc (compile-time)
- libvterm (compile & runtime)

Then compile aerc:

    $ make

## Installation

    # make install
    $ aerc

On its first run, aerc will copy the default config files to `~/.config/aerc`
and show the account configuration wizard.

## Contributing

Send patches to
[~sircmpwn/aerc@lists.sr.ht](mailto:~sircmpwn/aerc@lists.sr.ht).

Bugs & todo here: [~sircmpwn/aerc2](https://todo.sr.ht/~sircmpwn/aerc2)