about summary refs log tree commit diff stats
path: root/README.md
blob: 16505e1c7733da1f81a2dc5c5476db41688b47be (plain) (blame)
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
33
34
35
36
37
38
39
40
41
# aerc

aerc is a *work in progress* email client for your terminal.

It is not yet suitable for daily use.

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
    $ man aerc

## Usage

```
$ mkdir ~/.config/aerc
$ cp config/*.conf ~/.config/aerc/
$ vim ~/.config/aerc/accounts.conf
```

Fill in your account details and configure the rest to taste, then run `aerc`.

## 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)