initial commit

README.md

@@ -0,0 +1,19 @@
+There's [not much](https://notmuchmail.org/) [fuzz](https://junegunn.github.io/fzf/) about emails.
+
+[Yousef Akbar](https://yousef.sh/) developed a lovely [notmuch plugin](https://github.com/yousefakbar/notmuch.nvim) for [neovim.](https://neovim.io/)
+But since lately I find myself preferring [vim](https://www.vim.org/) over neovim, i was left with two options:
+adapt the plugin to vim, or write a shell script instead.
+This application is built around the second route.
+This is a POSIX-compliant script with internal `awk` elements for handling your notmuch-organized emails.
+You are free to choose whatever editor you prefer for writing emails.
+
+
+Requirements and Installation
+------------------------------
+### Requirements
+This is a POSIX-compliant shell script with inline `awk` elements that makes calls to:
+- the command-line fuzzy finder [fzf](https://junegunn.github.io/fzf/),
+- the command-line email system [notmuch](https://notmuchmail.org/)
+
+### Installation
+Run `./scripts/build.sh`, then copy `nmf` to your preferred location, e.g., `~/.local/bin`, and make it executable.