update README

This commit is contained in:
Iris Lightshard 2021-05-12 20:53:14 -06:00
parent 80d5a8db52
commit eb4238f6f1
Signed by: Iris Lightshard
GPG key ID: 3B7FBC22144E6398

View file

@ -52,17 +52,11 @@ window centered (its exact geometry is configurable via `config.h`).
### Dependencies, Building, Installation
Being forked from Rio, Ryudo requires `plan9port`, `Xlib`, and `Xt`.
If you enable notifications, it of course requires `notify-send`.
Make it with `mk ryudo` and then copy the resulting executable `ryudo` to
somewhere in your **PATH**
If you try to install it with `mk install` it will probably install
to `$PLAN9/bin/` under the name `rio`. This is less than ideal but I'm
not a master of mk, so my protocol is to use a mk target `ryudo` which
builds the program as `o.rio`, then calls `ryudomagic.sh` to rename
the program. A proper mkfile is planned before version 1.0.
Build with `build.sh` (calls `mk` and does some other magic), and install with `install.sh` (will install to a local folder if run as a normal user, or to your `$PLAN9/bin/` if run as root).
If you have trouble building, you might need to edit the **mkfile** at line 2
to point to the proper location of your plan9port's **mkwsysrules.sh**.
If you have trouble building, you might need to edit the `mkfile` at line 2
to point to the proper location of your plan9port's `mkwsysrules.sh`.
### Bugs and Caveats
Of the bugs and caveats not already mentioned in Rio's readme: