commit 1d57f265b2790ee109e69a10af49afc0aca50aa8
parent 71d6bf9e659591fae025bd3e779942d8b23b8820
Author: Luke Smith <luke@lukesmith.xyz>
Date: Mon, 22 Apr 2019 14:21:22 -0400
readme additions
Diffstat:
| M | README.md | | | 54 | ++++++++++++++++++++++++++---------------------------- |
1 file changed, 26 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
@@ -24,34 +24,30 @@ cd mutt-wizard
sudo make install
```
-The mutt-wizard is run with the command `mw`. It also installs the `mailsync` command.
+The mutt-wizard is run with the command `mw`. It also installs the `mailsync` command. Once everything is setup, you'll use `neomutt` to access your mail.
-Install these required programs:
+- `mw add` -- add a new email account
+- `mw ls` -- list existing accounts
+- `mw pass` -- revise an account's password
+- `mw delete` -- deleted an added account
+- `mw purge` -- delete all accounts and settings
+- `mw cron` -- toggle/configure a cronjob to sync mail
+
+## Dependencies
- `neomutt` - the email client.
- `isync` - downloads and syncs the mail. (required at install)
- `msmtp` - sends the email.
- `pass` - safely encrypts passwords (required at install)
-You also need a GPG key pair to encrypt passwords.
-If you don't know what that is, just run `gpg --full-gen-key` (or `gpg2 --full-gen-key`) to get one.
-You might also want some good optional stuff:
+### Optional
- `w3m` - view HTML email and images in neomutt.
- `notmuch` - index and search mail. Install it and run `notmuch setup`, tell it that your mail is in `~/.local/share/mail/`. You can run it in mutt with `ctrl-f`. Run `notmuch new` to process new mail, although the included `mailsync` script does this for you.
- `abook` - a terminal-based address book. Pressing tab while typing an address to send mail to will suggest contacts that are in your abook.
- A cron manager - if you want to enable the auto-sync feature.
-## Running mutt-wizard (`mw`)
-
-- `mw add` -- add a new email account
-- `mw ls` -- list existing accounts
-- `mw pass` -- revise an account's password
-- `mw delete` -- deleted an added account
-- `mw purge` -- delete all accounts and settings
-- `mw cron` -- toggle/configure a cronjob to sync mail
-
-## User interface
+## Neomutt user interface
To give you an example of the interface, here's an idea:
@@ -71,23 +67,16 @@ To give you an example of the interface, here's an idea:
## New stuff and improvements since the original release
- `isync`/`mbsync` has replaced `offlineimap` as the backend. Offlineimap was error-prone, bloated, used obsolete Python 2 modules and required separate steps to install the system.
-- `dialog` is no long used (le bloat) and the interface is simply text.
+- `mw` is now an installed program instead of just a script needed to be kept in your mutt folder.
+- `dialog` is no long used (le bloat) and the interface is simply text commands.
- More autogenerated shortcuts that allow quickly moving and copying mail between boxes.
- More elegant attachment handling. Image/video/pdf attachments without relying on the neomutt instance.
- abook integration by default.
-- The messy template files have been removed and are now a part of the script itself.
+- The messy template files and other directories have been moved or removed, leaving a clean config folder.
- msmtp configs moved to `~/.config/` and mail default location moved to `~/.local/share/mail/`, reducing mess in `~`.
-- `accounts/` hold account data and `bin/` holds script run by or for mutt. All other directories have been disintegrated.
- `pass` is used as a password manager instead of separately saving passwords.
- Script is POSIX sh compliant.
-- Error handling for the many people who don't read or follow directions.
-
-## Watch our for these things:
-
-- For Gmail accounts, remember also to enable third-party ("""less secure""") applications before attempting installation.
-- Protonmail accounts will require you to set up "Protonmail Bridge" to access PM's IMAP and SMTP servers. Configure that before running mutt-wizard.
-- If you have a university email, or enterprise-hosted email for work, there might be other hurdles or two-factor authentication you have to jump through. Some, for example, will want you to create a separate IMAP password, etc.
-- If you use an email server whose mailboxes are not in English, mutt-wizard might not be able to guess which is which, so you may have to manually set your Inbox, Sent, Trash, Drafts, etc. in your mutt config file. Do this after running the wizard in `accounts/NAME.muttrc`.
+- Error handling for the many people who don't read or follow directions. Less errors generally.
## Help the Project!
@@ -101,5 +90,14 @@ mutt-wizard is free/libre software, licensed under the GPLv3.
## Details for Tinkerers
-- `personal.muttrc`, called by the `muttrc`, is the place where user-specific settings are set, and the wizard automatically adds the macros for switching between accounts here. If you want to contribute to mutt-wizard, you should put your universal personal settings here and have git ignore it. For example, I put my gpg settings here and personal aliases here.
-- Accounts are generated in `accounts/`. If I create an account named `luke`, for example, `accounts/luke.muttrc` will hold that account's unique settings and `accounts/luke/` will hold headers and cache files.
+- The critical `mutt`/`neomutt` files are in `~/.config/mutt/`.
+- Put whatever global settings you want in `muttrc`. mutt-wizard will add some lines to this file which you shouldn't remove unless you know what you're doing, but you can move them up/down over your personal config lines if you need to. If you get binding conflict errors in mutt, you might need to do this.
+- Each of the accounts that mutt-wizard generates will have custom settings set in a separate file in `accounts/`. You can edit these freely if you want to tinker with settings specific to an account.
+- Don't modify the `mutt-wizard.muttrc` file as it is the system default and will be overwritten on update. If you don't like any settings set there, you can override them in your `muttrc`.
+
+## Watch our for these things:
+
+- For Gmail accounts, remember also to enable third-party ("""less secure""") applications before attempting installation.
+- Protonmail accounts will require you to set up "Protonmail Bridge" to access PM's IMAP and SMTP servers. Configure that before running mutt-wizard.
+- If you have a university email, or enterprise-hosted email for work, there might be other hurdles or two-factor authentication you have to jump through. Some, for example, will want you to create a separate IMAP password, etc.
+- If you use an email server whose mailboxes are not in English, mutt-wizard might not be able to guess which is which, so you may have to manually set your Inbox, Sent, Trash, Drafts, etc. in your mutt config file. Do this after running the wizard in `accounts/NAME.muttrc`.
