From 1227d3af6600c2071930ba7e9f1fbed638f7a233 Mon Sep 17 00:00:00 2001
From: JozanLeClerc <bousset.rudy@gmail.com>
Date: Fri, 6 Nov 2020 18:13:59 +0100
Subject: Added README

---
 README | 68 ++++++++++++++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 50 insertions(+), 18 deletions(-)

(limited to 'README')

diff --git a/README b/README
index a8fcdfe..2ac5178 100644
--- a/README
+++ b/README
@@ -1,24 +1,56 @@
-dmenu - dynamic menu
-====================
-dmenu is an efficient dynamic menu for X.
+dmenu - dynamic menu  for X
+===========================
 
-
-Requirements
+Introduction
 ------------
-In order to build dmenu you need the Xlib header files.
+This is my personnal build of dmenu, a simple dynamic menu for
+X which sucks less. I've applied some patches.
 
+Depedencies
+-----------
+- A C compiler
+- xorg
+- make
 
 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.
+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.
-- 
cgit v1.2.3