Freshen up readme with binary packages
This commit is contained in:
parent
91f29206a3
commit
889d89b42e
1 changed files with 34 additions and 13 deletions
47
README.md
47
README.md
|
@ -8,7 +8,34 @@ Join the IRC channel: [#aerc on irc.freenode.net](http://webchat.freenode.net/?c
|
||||||
for end-user support, and [#aerc-dev](http://webchat.freenode.net/?channels=aerc-dev&uio=d4)
|
for end-user support, and [#aerc-dev](http://webchat.freenode.net/?channels=aerc-dev&uio=d4)
|
||||||
for development.
|
for development.
|
||||||
|
|
||||||
## Building
|
## Usage
|
||||||
|
|
||||||
|
On its first run, aerc will copy the default config files to `~/.config/aerc`
|
||||||
|
on Linux or `~/Library/Preferences/aerc` on MacOS (or `$XDG_CONFIG_HOME/aerc` if set)
|
||||||
|
and show the account configuration wizard.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Binary Packages
|
||||||
|
|
||||||
|
Recent versions of aerc are available on:
|
||||||
|
- [Alpine](https://pkgs.alpinelinux.org/packages?name=aerc)
|
||||||
|
- [Arch](https://archlinux.org/packages/community/x86_64/aerc/)
|
||||||
|
- [macOS through Homebrew](https://formulae.brew.sh/formula/aerc)
|
||||||
|
|
||||||
|
And likely other platforms.
|
||||||
|
|
||||||
|
### From Source
|
||||||
|
|
||||||
Install the dependencies:
|
Install the dependencies:
|
||||||
|
|
||||||
|
@ -25,23 +52,17 @@ files (notmuch.h). Then compile aerc with the necessary build tags:
|
||||||
|
|
||||||
$ GOFLAGS=-tags=notmuch make
|
$ GOFLAGS=-tags=notmuch make
|
||||||
|
|
||||||
## Installation
|
To install aerc locally:
|
||||||
|
|
||||||
# make install
|
# make install
|
||||||
$ aerc
|
|
||||||
|
|
||||||
On its first run, aerc will copy the default config files to `~/.config/aerc`
|
|
||||||
on Linux or `~/Library/Preferences/aerc` on MacOS and show the account
|
|
||||||
configuration wizard.
|
|
||||||
|
|
||||||
If you redirect stdout to a file, logging output will be written to that file:
|
|
||||||
|
|
||||||
$ aerc > log
|
|
||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
[Send patches](https://git-send-email.io) and questions to
|
Send patches and questions to
|
||||||
[~sircmpwn/aerc@lists.sr.ht](https://lists.sr.ht/~sircmpwn/aerc).
|
[~sircmpwn/aerc@lists.sr.ht](https://lists.sr.ht/~sircmpwn/aerc)
|
||||||
|
|
||||||
|
Instructions for preparing a patch are available at
|
||||||
|
[git-send-email.io](https://git-send-email.io)
|
||||||
|
|
||||||
Subscribe to release announcements on
|
Subscribe to release announcements on
|
||||||
[~sircmpwn/aerc-announce](https://lists.sr.ht/~sircmpwn/aerc-announce)
|
[~sircmpwn/aerc-announce](https://lists.sr.ht/~sircmpwn/aerc-announce)
|
||||||
|
|
Loading…
Reference in a new issue