kitchen/kiwmi
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add execution details to README.adoc

Browse source
This commit is contained in:
Qazzquimby 2019-03-07 15:38:41 -08:00 • committed by GitHub
parent aed268c09c
commit 4c5bbfc95a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.adoc
View file

@ -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
------------