aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2019-01-13 20:09:07 -0500
committerDrew DeVault <sir@cmpwn.com>2019-01-13 20:09:07 -0500
commit501c95d852971775d64b97872fe63ecea367c525 (patch)
tree81bde8e9f9aa1b033c8266d9161f7bbb115cfa3f /README.md
parenta409a9faa50ef6669ab7ebd7f3d8e286deebc1eb (diff)
downloadaerc-501c95d852971775d64b97872fe63ecea367c525.tar.gz
Add README.md, update license (MIT -2019)
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b075e3f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# aerc
+
+aerc is a *work in progress* email client for your terminal.
+
+It is not yet suitable for daily use.
+
+## Building
+
+ go build
+
+## Usage
+
+Start by copying the example configs, `config/aerc.conf` and
+`config/accounts.conf` and editing them to taste, to `~/.config`. Then run
+`./aerc2`.
+
+## Contributing
+
+Send patches to
+[~sircmpwn/public-inbox@lists.sr.ht](mailto:~sircmpwn/public-inbox@lists.sr.ht).