summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README24
-rw-r--r--README.md32
2 files changed, 32 insertions, 24 deletions
diff --git a/README b/README
deleted file mode 100644
index a8fcdfe..0000000
--- a/README
+++ /dev/null
@@ -1,24 +0,0 @@
-dmenu - dynamic menu
-====================
-dmenu is an efficient dynamic menu for X.
-
-
-Requirements
-------------
-In order to build dmenu you need the Xlib header files.
-
-
-Installation
-------------
-Edit config.mk to match your local setup (dmenu is installed into
-the /usr/local namespace by default).
-
-Afterwards enter the following command to build and install dmenu
-(if necessary as root):
-
- make clean install
-
-
-Running dmenu
--------------
-See the man page for details.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59a7123
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# dmenu
+Saumit's fork of the suckless tool dmenu
+
+## Changes in this build
+Changes made from the vanilla dmenu [dmenu-5.2](https://dl.suckless.org/tools/dmenu-5.2.tar.gz) (2022-10-04)
+
+source: `git clone https://git.suckless.org/dmenu`
+
+1. <b>Fonts</b> - JetBrains mono and Joypixels
+2. <b>Xresources patch</b> and changes in dmenu.c for consistent colorschemes with dwm.
+3. <b> dmenu_exclude</b> removes dmenu options for dmenu_run. Useful to include terminal only commands and/or eliminating highpriority options that may interfere with the intended one
+4. <b>Additional patches:</b> [<i>source</i>](https://tools.suckless.org/dmenu/patches/)
+ - <b>Password patch</b> (-P)
+ - Hides dmenu input, this patch uses asterisks '*' instead of dots '.'
+ - <b>Highpriority patch</b> (-hp items)
+ - Automatically sorts the search result so that high priority items are shown first.
+ - <b>instant patch</b> (-n)
+ - use -n flag to immediately select the only matching option left
+ - <b>Mouse support patch</b>
+ - dmenu options are mouse clickable
+ - <b>lineheight patch</b>
+ - uses -h flag to set the minimum sets the minimum height of a dmenu line
+
+## Installation
+```
+sudo make clean install
+```
+
+### Debugging
+Make sure to use the command `rm ~/.cache/dmenu_run` if no options show up on dmenu_run
+## Licence
+[MIT](https://choosealicense.com/licenses/mit/)