aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README68
1 files changed, 18 insertions, 50 deletions
diff --git a/README b/README
index 2ac5178..a8fcdfe 100644
--- a/README
+++ b/README
@@ -1,56 +1,24 @@
-dmenu - dynamic menu for X
-===========================
+dmenu - dynamic menu
+====================
+dmenu is an efficient dynamic menu for X.
-Introduction
+
+Requirements
------------
-This is my personnal build of dmenu, a simple dynamic menu for
-X which sucks less. I've applied some patches.
+In order to build dmenu you need the Xlib header files.
-Depedencies
------------
-- A C compiler
-- xorg
-- make
Installation
------------
-To install this build, run these commands:
-
- $ git clone git://jozanleclerc.xyz/jozan/dmenu.git
- $ cd dmenu
- $ make
- # make install clean
-
-It is installed by default in the user /usr/local/bin directory but you can
-change it to something that matches more your $PATH by editing the PREFIX
-variable in config.mk.
-
-Applied patches
----------------
-You can find a list of patches and check what those I've applied are
-doing on dmenu's patches page.
-
-Here is my list:
- - border
- - case insensitive
- - center
- - fuzzyhighlight
- - fuzzymatch
- - line height
-
-Settings
---------
-Most settings are done by editing config.h and recompiling. All settings
-can also be configured via command line options, see
- $ man 1 dmenu
-for more informations.
-
- Fonts
- -----
- The default font is part of the Nerd Fonts collection but can
- be changed at config.h:11.
-
- Colors
- ------
- The colorscheme used in this build is gruvbox dark hard, you can
- change it at config.h:16.
+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.