lightswitch: Update README.md

Improve readability in the app launcher
pull/1336/head
storm64 2022-01-21 20:20:53 +01:00 committed by GitHub
parent ea7de8df2d
commit 8ab2a1ce65
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 13 deletions

View File

@ -21,17 +21,17 @@ In addition it shows the lock status with the option to personalize the lock ico
### Widget - Change the apperance of the widget: ### Widget - Change the apperance of the widget:
* __Bulb col__ * __Bulb col__
Available values: _red_ / _yellow_ / _green_ / __cyan__ / _blue_ / _magenta_ _red_ / _yellow_ / _green_ / __cyan__ / _blue_ / _magenta_
Define the color used for the lightbulbs inner circle. Define the color used for the lightbulbs inner circle.
The selected color will be dimmed depending on the actual brightness value. The selected color will be dimmed depending on the actual brightness value.
* __Image__ * __Image__
Available values: __defaut__ / _random_ / _..._ __defaut__ / _random_ / _..._
Set your favourite lock icon image. (If no image file is found _no image_ will be displayed.) Set your favourite lock icon image. (If no image file is found _no image_ will be displayed.)
* _random_ -> Select a random image on each time the widget is drawn. * _random_ -> Select a random image on each time the widget is drawn.
### Control - Change when and how to use the widget: ### Control - Change when and how to use the widget:
* __Touch__ * __Touch__
Available values: _on def clk_ / _on all clk_ / _clk+setting_ / _clk+launch_ / _except apps_ / __always on__ _on def clk_ / _on all clk_ / _clk+setting_ / _clk+launch_ / _except apps_ / __always on__
Select when touching the widget is active to en-/disable the backlight. Select when touching the widget is active to en-/disable the backlight.
* _on def clk_ -> only on your selected main clock face * _on def clk_ -> only on your selected main clock face
* _on all clk_ -> on all apps of the type _clock_ * _on all clk_ -> on all apps of the type _clock_
@ -40,41 +40,39 @@ In addition it shows the lock status with the option to personalize the lock ico
* _except apps_ -> on all apps of the types _clock_ and _launch_ and in the settings * _except apps_ -> on all apps of the types _clock_ and _launch_ and in the settings
* _always on_ -> always enabled when the widget is displayed * _always on_ -> always enabled when the widget is displayed
* __Drag Delay__ * __Drag Delay__
Available values: _off_ / _50ms_ / _100ms_ / _..._ / __500ms__ / _..._ / _1000ms_ _off_ / _50ms_ / _100ms_ / _..._ / __500ms__ / _..._ / _1000ms_
Change the maximum delay between first touch and retouch/drag to change the brightness or disable changing the brightness completely. Change the maximum delay between first touch and retouch/drag to change the brightness or disable changing the brightness completely.
* __Min Value__ * __Min Value__
Available values: _1%_ / _2%_ / _..._ / __10%__ / _..._ / _100%_ _1%_ / _2%_ / _..._ / __10%__ / _..._ / _100%_
Set the minimal level of brightness you can change to. Set the minimal level of brightness you can change to.
### Unlock - Set double tap side to unlock: ### Unlock - Set double tap side to unlock:
* __TapSide__ * __TapSide__
Available values: __off__ / _left_ / _right_ / _top_ / _bottom_ / _front_ / _back_ __off__ / _left_ / _right_ / _top_ / _bottom_ / _front_ / _back_
### Flash - Change if and how to flash the backlight: ### Flash - Change if and how to flash the backlight:
* __TapSide__ * __TapSide__
Available values: _off_ / _left_ / __right__ / _top_ / _bottom_ / _front_ / _back_ _off_ / _left_ / __right__ / _top_ / _bottom_ / _front_ / _back_
Set the side to double tap on to flash the backlight or disable completely. Set the side to double tap on to flash the backlight or disable completely.
* __Tap__ * __Tap__
Available values: _on locked_ / _on unlocked_ / __always on__ _on locked_ / _on unlocked_ / __always on__
Select when a double tap is recognised. Select when a double tap is recognised.
* __Timeout__ * __Timeout__
Available values: _0.5s_ / _1s_ / _..._ / __2s__ / _..._ / _10s_ _0.5s_ / _1s_ / _..._ / __2s__ / _..._ / _10s_
Change how long the backlight will be activated on a flash. Change how long the backlight will be activated on a flash.
* __Min Value__ * __Min Value__
Available values: _1%_ / _2%_ / _..._ / __20%__ / _..._ / _100%_ _1%_ / _2%_ / _..._ / __20%__ / _..._ / _100%_
Set the minimal level of brightness for the backlight on a flash. Set the minimal level of brightness for the backlight on a flash.
## Images ## ## Images ##
Examples in default light and dark theme. Examples in default light and dark theme.
| Lightbulb (full/dimmed/off) | Default lock icon (on/off) | | Lightbulb (full/dimmed/off) | Default lock icon (on/off) |
|:---------------------------:|:--------------------------:| |:---------------------------:|:--------------------------:|
| ![](images/lightbulb.png) | ![](images/default.png) | | ![](images/lightbulb.png) | ![](images/default.png) |
The following images are stored in a seperate file _(lightswitch.images.json)_: The following images are stored in a seperate file _(lightswitch.images.json)_:
| Lock (on/off) | Heart | Invader | JS | Smiley | Skull | Storm | | Lock (on/off) | Heart | Invader | JS | Smiley | Skull | Storm |
|:-------------:|:-----:|:-------:|:--:|:------:|:-----:|:-----:| |:-------------:|:-----:|:-------:|:--:|:------:|:-----:|:-----:|
| ![](images/image_lock.png) | ![](images/image_heart.png) | ![](images/image_invader.png) | ![](images/image_js.png) | ![](images/image_smiley.png) | ![](images/image_skull.png) | ![](images/image_storm.png) | | ![](images/image_lock.png) | ![](images/image_heart.png) | ![](images/image_invader.png) | ![](images/image_js.png) | ![](images/image_smiley.png) | ![](images/image_skull.png) | ![](images/image_storm.png) |