From 4c5bbfc95a99ff2bcc6370b1c2088a35f0a2d246 Mon Sep 17 00:00:00 2001 From: Qazzquimby Date: Thu, 7 Mar 2019 15:38:41 -0800 Subject: [PATCH] Add execution details to README.adoc --- README.adoc | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.adoc b/README.adoc index 9a9de19..b0e0af5 100644 --- a/README.adoc +++ b/README.adoc @@ -44,6 +44,26 @@ Install with: # ninja -C build install ---- +Using kiwmi +----------- + +### Execution +kiwmi can be run in X or another Wayland compositor, and will automatically use an appropriate backend. + +**WARNING:** kiwmi cannot yet be run in a TTY. Running kiwmi in a TTY at this time will softlock the machine. + + +### Sending commands from kiwmic to kiwmi +kiwmic is not implemented at this time. + +When kiwmic is implemented, it will use the interface `kiwmic COMMAND [PARAMETERS]...` + +### Configuring kimwi +kimwi is not yet configurable. + +Recommended configurations will be supplied to make setup easier. + + Contribution ------------