aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--LICENSE2
-rw-r--r--README.md20
2 files changed, 21 insertions, 1 deletions
diff --git a/LICENSE b/LICENSE
index 3f02e822..ec27f618 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2018 Drew DeVault
+Copyright (c) 2018-2019 Drew DeVault
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
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).