aerc/README.md

42 lines
773 B
Markdown
Raw Normal View History

# aerc
aerc is a *work in progress* email client for your terminal.
It is not yet suitable for daily use.
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)
## Building
2019-05-25 21:55:50 +02:00
Install the dependencies:
2019-05-18 00:15:50 +02:00
- go (compile-time)
- scdoc (compile-time)
- libvterm (compile & runtime)
2019-05-25 21:55:50 +02:00
Then compile aerc:
2019-05-17 19:45:20 +02:00
$ make
## Installation
# make install
$ man aerc
## Usage
2019-03-22 03:07:03 +01:00
```
$ mkdir ~/.config/aerc
$ cp config/*.conf ~/.config/aerc/
$ vim ~/.config/aerc/accounts.conf
```
2019-05-17 19:45:20 +02:00
Fill in your account details and configure the rest to taste, then run `aerc`.
## Contributing
Send patches to
2019-05-11 20:30:57 +02:00
[~sircmpwn/aerc@lists.sr.ht](mailto:~sircmpwn/aerc@lists.sr.ht).
2019-03-17 22:47:35 +01:00
Bugs & todo here: [~sircmpwn/aerc2](https://todo.sr.ht/~sircmpwn/aerc2)