commit c1be85ddedd88f793f93bdc21dc55851341d524f from: Omar Polo date: Thu Jun 14 15:07:05 2018 UTC updated README.md + links to md version of the manpage commit - 0d0d65c988542bbec3a983519262b1d92dd613d3 commit + c1be85ddedd88f793f93bdc21dc55851341d524f blob - 1c97aa8c4a0ee66bfddd4b28cba06757db542af5 blob + 014be858f2881917d2d12bf4683bbf0ccb65379a --- README.md +++ README.md @@ -14,24 +14,22 @@ This is a replacement for `dmenu(1)`. ## Why? -This was the perfect excuse to learn how to make window with Xlib. +This was the perfect excuse to learn how to use Xlib. ## How? -Check out the [manpage](mymenu.1) for further documentation. Check out -also the [template](Xexample) for the resources. +Check out the [manpage](mymenu.1.md) for further documentation. Check +out also the [template](Xexample) for the resources. --- ## Dependencies - Xlib - - Xinerama (optional) - For multi-monitor support - - Xft (optional) - For TrueType (r) font support - - pkg-config (optional) - used in the makefile to generate `LIBS` and `CFLAGS` correctly + - Xinerama (optional) for multi-monitor support + - Xft (optional) for TrueType font support + - pkg-config (optional) used in the makefile to generate `LIBS` and + `CFLAGS` correctly ## Build @@ -64,22 +62,22 @@ should be enough. - Will feature $X be added? - No. Or maybe Yes. In fact, it depends. Open an issue and let's + No. Or maybe yes. In fact, it depends. Open an issue and let's discuss. If it's something that's trivial to achieve in combo with other tool maybe is not the case to add it here. - Is feature $Y present? What $Z do? How to achieve $W? - Everything is documented in the man page. To read it, simply execute - `man -l mymenu.1` or `mandoc mymenu.1 | less` (depending on your - system the `-l` option may not be present). + Everything is documented in the [man page](mymenu.1.md). To read + it, simply execute `man -l mymenu.1` or `mandoc mymenu.1 | less` + (depending on your system the `-l` option may not be present). --- ## TODO - Improve UTF8 support - + The whole UTF8 support is still kinda naïve and should definitely be improved.