update documentation

This commit is contained in:
speedie 2023-06-09 06:12:23 +02:00
parent fc2180ebbe
commit a0ee7e8fcd
4 changed files with 10 additions and 18 deletions

View file

@ -188,9 +188,9 @@ goes through features in more detail.</p>
<p>spmenu also serves as a proper dmenu replacement for Wayland users, <p>spmenu also serves as a proper dmenu replacement for Wayland users,
and can be themed to look identical to dmenu.</p> and can be themed to look identical to dmenu.</p>
<h2 id="screenshots">Screenshots</h2> <h2 id="screenshots">Screenshots</h2>
<p><img src="screenshots/desktop-launcher.png" <p><img src="screenshots/typing.gif" alt="typing" /> <img
alt=".desktop launcher" /> <img src="screenshots/typing.gif" src="screenshots/desktop-launcher.png" alt=".desktop launcher" /> <img
alt="typing" /> <img src="screenshots/bliss.png" alt="bliss" /></p> src="screenshots/bliss.png" alt="bliss" /></p>
<h2 id="dependencies">Dependencies</h2> <h2 id="dependencies">Dependencies</h2>
<ul> <ul>
<li>wayland-client <li>wayland-client
@ -248,9 +248,9 @@ build systems.</li>
<h2 id="installation">Installation</h2> <h2 id="installation">Installation</h2>
<ul> <ul>
<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-aur">my repository</a>
repository</a> which includes <code>spmenu</code> as well as other which includes <code>spmenu</code> as well as other useful packages.
useful packages. Then simply <code>pacman -S spmenu</code>.</p></li> Then simply <code>pacman -S spmenu</code>.</p></li>
<li><p>Or if you are on Gentoo GNU/Linux, you can add <a <li><p>Or if you are on Gentoo GNU/Linux, you can add <a
href="https://git.speedie.site/speedie/speedie-overlay">my overlay</a> href="https://git.speedie.site/speedie/speedie-overlay">my overlay</a>
which includes <code>x11-misc/spmenu</code> as well as other useful which includes <code>x11-misc/spmenu</code> as well as other useful
@ -296,11 +296,6 @@ instead.</p>
not currently work under Wayland. Some will never work under Wayland due not currently work under Wayland. Some will never work under Wayland due
to limitations. These are:</p> to limitations. These are:</p>
<ul> <ul>
<li>Image support
<ul>
<li>Images simply will not be drawn on Wayland.</li>
<li>Will eventually be solved by replacing imlib2 with cairo.</li>
</ul></li>
<li><code>--x-position</code> and <code>--y-position</code> arguments <li><code>--x-position</code> and <code>--y-position</code> arguments
<ul> <ul>
<li>These arguments do not work under Wayland, because the layer_shell <li>These arguments do not work under Wayland, because the layer_shell

View file

@ -20,8 +20,8 @@ can be themed to look identical to dmenu.
## Screenshots ## Screenshots
![.desktop launcher](screenshots/desktop-launcher.png)
![typing](screenshots/typing.gif) ![typing](screenshots/typing.gif)
![.desktop launcher](screenshots/desktop-launcher.png)
![bliss](screenshots/bliss.png) ![bliss](screenshots/bliss.png)
## Dependencies ## Dependencies
@ -56,7 +56,7 @@ disabled during compile time.
## Installation ## Installation
- 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-aur) 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`.
- Or if you are on Gentoo GNU/Linux, you can add - Or if you are on Gentoo GNU/Linux, you can add
@ -122,9 +122,6 @@ Note that Wayland support is still experimental, and some features do not
currently work under Wayland. Some will never work under Wayland due to limitations. currently work under Wayland. Some will never work under Wayland due to limitations.
These are: These are:
- Image support
- Images simply will not be drawn on Wayland.
- Will eventually be solved by replacing imlib2 with cairo.
- `--x-position` and `--y-position` arguments - `--x-position` and `--y-position` arguments
- These arguments do not work under Wayland, because the layer_shell - These arguments do not work under Wayland, because the layer_shell
protocol doesn't allow clients to be placed on a specific position. protocol doesn't allow clients to be placed on a specific position.

View file

@ -1,5 +1,5 @@
'\" t '\" t
.\" Automatically generated by Pandoc 3.1 .\" Automatically generated by Pandoc 3.1.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.1 .\" Automatically generated by Pandoc 3.1.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.