From c04e9a440fd1718aa0f5b3ddf7f7fc2e4489ad39 Mon Sep 17 00:00:00 2001 From: = <=> Date: Tue, 19 Jan 2021 11:17:50 -0500 Subject: [PATCH] Make README easier to understand --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8447bad..955d626 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,35 @@ This is a collection of scripts I use to make managing files and processes easie Use it to automagically select and run terminal applications, send signals to daemons, execute arbitrary commands, search the web, grab passwords from a password manager, and more. ## Installing dependencies -`sudo apt install pass enscript dunst xclip scrot mpc mpd ghostscript zathura suckless-tools` +`sudo apt install pass enscript dunst xclip scrot mpc mpd ghostscript zathura +suckless-tools youtube-dl` All of them are optional except suckless-tools. Many of the features aren't interdependent and are made up of 1 or 2 functions. ## prompt It's the central script that gives the rest of the features interactivity. Read the source code for more details. ### Usage - prompt [ launch | action | cmd | ddg | manual ] - pages [ open ] + prompt [ launch | action | cmd | cmd_clip | github | godoc | ddg | manual | username | password | other_password | edit_password | open | edit ] + +Generaly, prompt has two types of commands, launch commands and action +commands. Launch commands are used to open applications, manual pages, or spawn +other windows. Action commands modify daemons or read/write th the clipboard. +`prompt launch` and `prompt action` are the only commands you really need to +know because they will prompt for all the rest. The other command line subcommands are for +convenience and may be removed in the future. + +###Notes +* The download action uses youtube-dl to download whatever is in the keyboard to ~/Downloads/tmp + +##mru +Used for indexing and ranking frequently accessed files to ~/.cache/mru ## pages -pages is a command for viewing /tmp/pages-{number} files with less or zathura. The files are the result of prompt commands like `prompt action` -> Go page or can be created from your own tools. I use it for viewing documentation. +pages is a command for viewing /tmp/pages-{number} files with less or zathura. +The files are the result of prompt commands like `prompt action` -> Go page or +can be created from your own tools. I use it for viewing documentation. +### Usage + pages [ open ] - [ dmenu ](http://tools.suckless.org/dmenu/) for the prompts. It can be changed to rofi or some other solution