From 13b4c95982fe42252b81d4089fd3cf1d3782bd32 Mon Sep 17 00:00:00 2001 From: speedie Date: Mon, 3 Apr 2023 00:53:42 +0200 Subject: [PATCH] update docs and pkgbuild --- PKGBUILD | 2 +- README.html | 1 + README.md | 1 + docs/docs.md | 10 ++++++---- options.h | 5 +++-- spmenu.1 | 10 +++++----- 6 files changed, 17 insertions(+), 12 deletions(-) diff --git a/PKGBUILD b/PKGBUILD index a0cff95..8286f78 100644 --- a/PKGBUILD +++ b/PKGBUILD @@ -3,7 +3,7 @@ pkgname=spmenu pkgver=VERSION pkgrel=1 -pkgdesc="speedie's fork of suckless dmenu with color support and more" +pkgdesc="Fancy dynamic menu, compatible with dmenu!" url="https://git.speedie/gq/spmenu" arch=(i686 x86_64) license=(MIT) diff --git a/README.html b/README.html index 0c2889e..adf1149 100644 --- a/README.html +++ b/README.html @@ -153,6 +153,7 @@ allowing keybinds to be configured without recompiling spmenu.
  • Image support: Stop using OpenSSL for caching images, mostly because MD5() is deprecated as of OpenSSL 3.0, but this would also make it very easy to have LibreSSL compatibility.
    • +
  • Image support: Ability to display icons, similar to rofi
  • Matching: Add support for contextual completions similar to xprompt
  • Text drawing: Use cairo for text drawing over Xft.
    • diff --git a/README.md b/README.md index 9940152..757b7d7 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,7 @@ keybinds to be configured without recompiling spmenu. - Image support: Stop using OpenSSL for caching images, mostly because MD5() is deprecated as of OpenSSL 3.0, but this would also make it very easy to have LibreSSL compatibility. +- Image support: Ability to display icons, similar to rofi - Matching: Add support for contextual completions similar to xprompt - Text drawing: Use cairo for text drawing over Xft. - Matching: FIFO, used to dynamically refresh entries. diff --git a/docs/docs.md b/docs/docs.md index df1f1bd..7206d7e 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -2,11 +2,13 @@ spmenu ====== spmenu is a program for X11 that reads standard input and allows the user to -select items separated by a newline. It is a fork of suckless's dmenu which is -a good more minimal alternative to spmenu. +select items separated by a newline. It is a fork of +[suckless's dmenu](https://tools.suckless.org/dmenu) which is a good more +minimal alternative to spmenu. -Unlike dmenu and the many builds out there, spmenu has features like color -support, Vim-like modes, image support, proper keybind configuration, and more. +What makes spmenu different from all the dmenu forks is that spmenu has +features like color support, Vim-like modes, image support, +proper mouse/keybind configuration, and more. It should be noted that most of these features may be disabled by the user, either during compile time or through configuration. diff --git a/options.h b/options.h index 3da6dad..c25b1bd 100644 --- a/options.h +++ b/options.h @@ -1,6 +1,7 @@ -/* spmenu +/* spmenu - fancy dynamic menu + * * Below is a configuration file which is technically C source code. - * See the LICENSE file for license details. + * See the included LICENSE file for license details. */ /* spmenu options */ diff --git a/spmenu.1 b/spmenu.1 index 6063851..64201c6 100644 --- a/spmenu.1 +++ b/spmenu.1 @@ -20,12 +20,12 @@ .PP spmenu is a program for X11 that reads standard input and allows the user to select items separated by a newline. -It is a fork of suckless\[cq]s dmenu which is a good more minimal -alternative to spmenu. +It is a fork of suckless\[cq]s dmenu (https://tools.suckless.org/dmenu) +which is a good more minimal alternative to spmenu. .PP -Unlike dmenu and the many builds out there, spmenu has features like -color support, Vim-like modes, image support, proper keybind -configuration, and more. +What makes spmenu different from all the dmenu forks is that spmenu has +features like color support, Vim-like modes, image support, proper +mouse/keybind configuration, and more. .PP It should be noted that most of these features may be disabled by the user, either during compile time or through configuration.