From e85a0b972823ba2c46dd834213bc47985c462687 Mon Sep 17 00:00:00 2001 From: speedie Date: Mon, 5 Jun 2023 05:15:49 +0200 Subject: [PATCH] update docs slightly, update .gitignore --- .gitignore | 1 + README.html | 30 ++---------------------------- README.md | 28 ++-------------------------- spmenu.1 | 2 +- spmenu_run.1 | 2 +- 5 files changed, 7 insertions(+), 56 deletions(-) diff --git a/.gitignore b/.gitignore index ef6af8d..84b9dce 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ *gz* *tar* spmenu +*[.]PKGBUILD buildconf_dev buildconf build diff --git a/README.html b/README.html index 9edc8c4..50f2084 100644 --- a/README.html +++ b/README.html @@ -173,7 +173,6 @@

spmenu

-

What is spmenu?

spmenu is a simple X11 and Wayland menu application which takes standard input, parses it, lets the user choose an option and sends the selected option to standard output.

@@ -226,8 +225,8 @@ time.
  • Used to calculate MD5 of images if image support is enabled, can be disabled during compile time.
    • -
  • Pango
    • -
  • Cairo
    • +
  • pango
    • +
  • cairo
  • libconfig

    Installation

    -

    TODO

    -

    Pull requests would be greatly appreciated for any of these -issues!

    -

    Scripts

    There’s a page dedicated to user scripts over on the diff --git a/README.md b/README.md index a7881a1..451b880 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,6 @@ spmenu ====== -## What is spmenu? - spmenu is a simple X11 and Wayland menu application which takes standard input, parses it, lets the user choose an option and sends the selected option to standard output. @@ -41,8 +39,8 @@ It also serves as a dmenu replacement for Wayland users. - OpenSSL - Used to calculate MD5 of images if image support is enabled, can be disabled during compile time. -- Pango -- Cairo +- pango +- cairo - libconfig - Can be disabled if you don't want/need config file support during compile time. - meson @@ -50,9 +48,6 @@ disabled during compile time. ## Installation -- If you're using macOS you may want to consider looking at [this wiki artic -le](https://spmenu.speedie.site/index.php/Using+spmenu+on+macOS) for more information. - - If you are on Arch GNU/Linux, you can add [my repository](https://git.speedie.site/speedie/speedie-repository) which includes `spmenu` as well as other useful packages. Then simply `pacman -S spmenu`. @@ -114,9 +109,6 @@ To generate a tarball, run `scripts/make/generate-pkg.sh` **in the current directory**. If you want to generate a Pacman package, run `scripts/make/generate-pacman-pkg.sh` instead. -See [this wiki article](https://spmenu.speedie.site/index.php/Using+spmenu+on+macOS) -for more information. - ## Wayland support Note that Wayland support is still experimental, and some features do not @@ -137,22 +129,6 @@ These are: - Window borders - Pasting -## TODO - -Pull requests would be greatly appreciated for any of these issues! - -- 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 -- Lines: Rofi-like newlines in the same entry - - Just need to `XMoveResizeWindow()` as well as `mh += bh` and `y += bh` - for each added line. -- Matching: Add support for contextual completions similar to xprompt -- Matching: Regex matching -- X11: Move from Xlib to libXcb -- Wayland: Anything listed as broken under 'Wayland support'. - ## Scripts There's a page dedicated to user scripts diff --git a/spmenu.1 b/spmenu.1 index febf9e1..42aa100 100644 --- a/spmenu.1 +++ b/spmenu.1 @@ -1,5 +1,5 @@ '\" t -.\" Automatically generated by Pandoc 3.0.1 +.\" Automatically generated by Pandoc 3.1 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. diff --git a/spmenu_run.1 b/spmenu_run.1 index 5ae3f5f..0233ead 100644 --- a/spmenu_run.1 +++ b/spmenu_run.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 3.0.1 +.\" Automatically generated by Pandoc 3.1 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font.