readme with optional dependencies
This commit is contained in:
parent
567fdd08d2
commit
aa1bdbb7d6
13
README.md
13
README.md
@ -26,13 +26,13 @@ Note also that Gmail and some providers require you to enable sign-ins from thir
|
||||
|
||||
## Installation and Dependencies
|
||||
|
||||
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.)
|
||||
`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.)
|
||||
|
||||
```
|
||||
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.
|
||||
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:
|
||||
|
||||
@ -42,6 +42,15 @@ Just run `mutt-wizard.sh` for all the options, to install an account:
|
||||
|
||||
Whenever you want to check for mail, just run the `offlineimap` command again.
|
||||
|
||||
### Non-essential dependencies
|
||||
|
||||
The automatically deployed configs will look for certain programs for certain extra abilities. Consider installing the following for the extra functionality.
|
||||
|
||||
+ `urlview` -- Detecting and following links with `ctrl-u`
|
||||
+ `mupdf` -- for viewing attached pdfs (`v` to view attachments, then select .pdf)
|
||||
+ `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.
|
||||
|
||||
### "Wait? The script asks for my passwords?"
|
||||
|
||||
Look at the code. The script takes the passwords you give it, encrypts them immediately with your own GPG key, and shreds the leftovers. Nothing malicious; it's all there! If it makes you comfortable you can even run the script offline at first.
|
||||
|
Loading…
Reference in New Issue
Block a user