summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFred Frey <f.frey6@gmail.com>2018-03-17 01:16:22 -0400
committerFred Frey <f.frey6@gmail.com>2018-03-17 01:16:22 -0400
commit944d8cb128d235a028cba3b982e94369dc8a0d94 (patch)
tree03d4d6106a8af23b9a425dd382576b336859910a /README.md
parentbaac8f2ee4079c374147d49e1d29446bd375005e (diff)
parent459ca7d5a0f9737dba5fb42315dac0237397c8fb (diff)
Merge branch 'master' of https://github.com/LukeSmithxyz/mutt-wizard
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 4 insertions, 11 deletions
diff --git a/README.md b/README.md
index e27d766..7d34042 100644
--- a/README.md
+++ b/README.md
@@ -10,8 +10,8 @@ The mutt-wizard is all of this in a simple ncurses menu. It's really just a litt
The system takes an email and autodetect its server settings, generating a muttrc and offlineimaprc profile automatically. If it can't do so, it simply prompts you for these (which you can easily look up) and will put them all in the right places. You get:
-+ Automatic configuration of mutt and offlineimap
-+ Automatic encryption and safe storage of passwords which are used by mutt and offlineimap when necessary
++ Automatic configuration of mutt and offlineimap.
++ Automatic encryption and safe storage of passwords which are used by mutt and offlineimap when necessary.
+ Multiple account management in mutt: jump from account to account with the `i` prefix in mutt: `i1`: first email account, `i5`: fifth, etc.
+ Easy movement to mail folders in mutt: `gi`: go to inbox, `gs` to sent mail, `ga` to archive, `gS` to spam, `gd` to drafts, etc.
+ Some default controls and colors. This system is going to be integrated into my [public auto-rice script](https://larbs.xyz) so I want it to look pretty and be usable out the box.
@@ -27,8 +27,6 @@ Note also that Gmail and some providers require you to enable sign-ins from thir
## Installation and Dependencies
-> **MacOS prerequisites** - Install `iproute2mac` and `mpv` ( brew install iproute2mac mpv )
-
`dialog`, `neomutt` and `offlineimap` should be installed. You also need to have a GPG public/private key pair for the wizard to automatically store your passwords. The whole repo should be cloned to `~/.config/mutt/`. (If you have a previous mutt folder, you'll want to back it up or delete it first.)
```
@@ -37,13 +35,7 @@ git clone https://github.com/LukeSmithxyz/mutt-wizard.git ~/.config/mutt
You will want to delete or rename your current `~/.offlineimaprc` as well, as although you can later modify the `~/.offlineimaprc` produced by the script, you must have no file there the first time you add your first account or the wizard will assume some settings are already set which aren't.
-Just run `mutt-wizard.sh` for all the options, to install an account:
-
-* First, select the "Add an account" option and give the script your account information.
-* Second, in a separate terminal, start your mail sync by running `offlineimap` or `offlineimap -a <your account name>`. This will start downloading all your mail for offline access.
-* Third, once your mailbox has started to download, reenter the script and select the "Auto-detect mailboxes" open. This will finalize the install and let you open up mutt to see your mail.
-
-Whenever you want to check for mail, just run the `offlineimap` command again.
+Just run `mutt-wizard.sh` and choose to add an account. After you do so, you may run `offlineimap` to begin the mailsync, and you will be able to run neomutt and see your mail.
### Non-essential dependencies
@@ -54,6 +46,7 @@ The automatically deployed configs will look for certain programs for certain ex
+ `notmuch` -- for mail searching and indexing set to `ctrl-f`. Be sure to run `notmuch setup`. Remember your mail is in `~/.mail/` when you configure notmuch.
+ `w3m` and/or `w3mimg` -- for viewing images. Like .pdfs, view in the attachments menu.
+ A cron manager if you want the autosync feature.
++ `iproute2mac` for Mac users who want the autosync feature.
+ `mpv` if you want the autosync feature to notify you with a ding on new mail.
### "Wait? The script asks for my passwords?"