commit c63af0789f4b8d4eee682f128f346793bf5b4b93 parent dc3aa43ea6bc7a4b2fe61d87fc1b70578309e23c Author: Scarlett McAllister <git@roygbyte.com> Date: Thu, 24 Aug 2023 00:40:46 -0300 Add more info to readme Signed-off-by: Christoph Lohmann <20h@r-36.net> Diffstat:
| M | README.md | | | 27 | +++++++++++++++++++++++++++ |
1 file changed, 27 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -18,6 +18,26 @@ See the LICENSE file for the terms. ## Installation +Installation of plumb can be done manually or via the makefile. By +default it installs to `bin` inside the user's home directory (note: +some plumb users find it is easiest to install plumb to +`/usr/local/bin`.) After plumb is installed, you should probably add +the program's location to the user's path and export environmental +variables for openers. + + % export PATH="$PATH:<location_of_plumb>" + % export XTERM=<your preferred_xterminal xterm?> + % export PLUMB_IMAGE=<your_preferred_image_viewer feh -F --auto-rotate?> + % export PLUMB_MEDIA=<your_preferred_mediaplayer mpv?> + % export PLUMB_GOPHER=<your_preferred_gopher_browser gopher?> + % export PLUMB_TXTGOPHER=<your_preferred_gopher_textbrowser gopher?> + % export PLUMB_PDF=<your_preferred_pdf_viewer xpdf?> + % export PLUMB_FILEMANAGER=<your_preferred_filemanager ranger?> + % export PLUMB_WEB=<your_preferred_webbrowser firefox?> + % export PLUMB_TXTWEB=<your_preferred_text_webbrowser lynx?> + +### Manual + # Copy the symlinks you like. I use all of them. % cp bin/plumber $HOME/bin % cp -a bin/p $HOME/bin @@ -29,6 +49,13 @@ See the LICENSE file for the terms. % export XTERM=<your_preferred_xterminal> # Add the above to your .mkshrc or .bashrc to make permanent. +### Makefile + + # Install plumb to user's $HOME + % make install + # Or, install to a specific directory + % make install INSTALL_DIR=/usr/local/bin + ## Usage % p http://www.searx.me