update docs slightly, update .gitignore

This commit is contained in:
speedie 2023-06-05 05:15:49 +02:00
parent 9741f0d02e
commit e85a0b9728
5 changed files with 7 additions and 56 deletions

1
.gitignore vendored
View file

@ -5,6 +5,7 @@
*gz* *gz*
*tar* *tar*
spmenu spmenu
*[.]PKGBUILD
buildconf_dev buildconf_dev
buildconf buildconf
build build

View file

@ -173,7 +173,6 @@
<figcaption aria-hidden="true">spmenu logo</figcaption> <figcaption aria-hidden="true">spmenu logo</figcaption>
</figure> </figure>
<h1 id="spmenu">spmenu</h1> <h1 id="spmenu">spmenu</h1>
<h2 id="what-is-spmenu">What is spmenu?</h2>
<p>spmenu is a simple X11 and Wayland menu application which takes <p>spmenu is a simple X11 and Wayland menu application which takes
standard input, parses it, lets the user choose an option and sends the standard input, parses it, lets the user choose an option and sends the
selected option to standard output.</p> selected option to standard output.</p>
@ -226,8 +225,8 @@ time.</li>
<li>Used to calculate MD5 of images if image support is enabled, can be <li>Used to calculate MD5 of images if image support is enabled, can be
disabled during compile time.</li> disabled during compile time.</li>
</ul></li> </ul></li>
<li>Pango</li> <li>pango</li>
<li>Cairo</li> <li>cairo</li>
<li>libconfig <li>libconfig
<ul> <ul>
<li>Can be disabled if you dont want/need config file support during <li>Can be disabled if you dont want/need config file support during
@ -241,9 +240,6 @@ build systems.</li>
</ul> </ul>
<h2 id="installation">Installation</h2> <h2 id="installation">Installation</h2>
<ul> <ul>
<li><p>If youre using macOS you may want to consider looking at <a
href="https://spmenu.speedie.site/index.php/Using+spmenu+on+macOS">this
wiki artic le</a> for more information.</p></li>
<li><p>If you are on Arch GNU/Linux, you can add <a <li><p>If you are on Arch GNU/Linux, you can add <a
href="https://git.speedie.site/speedie/speedie-repository">my href="https://git.speedie.site/speedie/speedie-repository">my
repository</a> which includes <code>spmenu</code> as well as other repository</a> which includes <code>spmenu</code> as well as other
@ -288,9 +284,6 @@ directory</strong>.</p>
<strong>in the current directory</strong>. If you want to generate a <strong>in the current directory</strong>. If you want to generate a
Pacman package, run <code>scripts/make/generate-pacman-pkg.sh</code> Pacman package, run <code>scripts/make/generate-pacman-pkg.sh</code>
instead.</p> instead.</p>
<p>See <a
href="https://spmenu.speedie.site/index.php/Using+spmenu+on+macOS">this
wiki article</a> for more information.</p>
<h2 id="wayland-support">Wayland support</h2> <h2 id="wayland-support">Wayland support</h2>
<p>Note that Wayland support is still experimental, and some features do <p>Note that Wayland support is still experimental, and some features do
not currently work under Wayland. Some will never work under Wayland due not currently work under Wayland. Some will never work under Wayland due
@ -318,25 +311,6 @@ be layered as normal.</li>
<li>Window borders</li> <li>Window borders</li>
<li>Pasting</li> <li>Pasting</li>
</ul> </ul>
<h2 id="todo">TODO</h2>
<p>Pull requests would be greatly appreciated for any of these
issues!</p>
<ul>
<li>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.</li>
<li>Image support: Ability to display icons, similar to rofi</li>
<li>Lines: Rofi-like newlines in the same entry
<ul>
<li>Just need to <code>XMoveResizeWindow()</code> as well as
<code>mh += bh</code> and <code>y += bh</code> for each added line.</li>
</ul></li>
<li>Matching: Add support for contextual completions similar to
xprompt</li>
<li>Matching: Regex matching</li>
<li>X11: Move from Xlib to libXcb</li>
<li>Wayland: Anything listed as broken under Wayland support.</li>
</ul>
<h2 id="scripts">Scripts</h2> <h2 id="scripts">Scripts</h2>
<p>Theres a page dedicated to user scripts <a <p>Theres a page dedicated to user scripts <a
href="https://spmenu.speedie.site/index.php/User+scripts">over on the href="https://spmenu.speedie.site/index.php/User+scripts">over on the

View file

@ -3,8 +3,6 @@
spmenu spmenu
====== ======
## What is spmenu?
spmenu is a simple X11 and Wayland menu application which takes standard input, parses 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. 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 - OpenSSL
- Used to calculate MD5 of images if image support is enabled, can be - Used to calculate MD5 of images if image support is enabled, can be
disabled during compile time. disabled during compile time.
- Pango - pango
- Cairo - cairo
- libconfig - libconfig
- Can be disabled if you don't want/need config file support during compile time. - Can be disabled if you don't want/need config file support during compile time.
- meson - meson
@ -50,9 +48,6 @@ disabled during compile time.
## Installation ## 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 - If you are on Arch GNU/Linux, you can add
[my repository](https://git.speedie.site/speedie/speedie-repository) which includes [my repository](https://git.speedie.site/speedie/speedie-repository) which includes
`spmenu` as well as other useful packages. Then simply `pacman -S spmenu`. `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 directory**. If you want to generate a Pacman package, run
`scripts/make/generate-pacman-pkg.sh` instead. `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 ## Wayland support
Note that Wayland support is still experimental, and some features do not Note that Wayland support is still experimental, and some features do not
@ -137,22 +129,6 @@ These are:
- Window borders - Window borders
- Pasting - 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 ## Scripts
There's a page dedicated to user scripts There's a page dedicated to user scripts

View file

@ -1,5 +1,5 @@
'\" t '\" 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 .\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font. .\" that render this, and otherwise B font.

View file

@ -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 .\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font. .\" that render this, and otherwise B font.