X-Git-Url: https://adrianiainlam.tk/git/?p=indicator-keyboard-led.git;a=blobdiff_plain;f=README.md;fp=README.md;h=581faca4c5fb8e883dc216fce377373ac1e8b305;hp=345b077ea80b05cdce24ca3a01b221c512f19fd0;hb=170ff3962573a8e5ff03539732d59ef3fe05dbd0;hpb=2b75a98cac06d251cb7c0f687bd36a3278d5fd74 diff --git a/README.md b/README.md index 345b077..581faca 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,6 @@ the respective item in the menu. ![indicator short][sc3] Alternative (short) appearance of the indicator. -[sc1]: screenshots/sc1.png -[sc2]: screenshots/sc2.png -[sc3]: screenshots/sc3.png - ## Dependencies - Python 3 (*) - GTK+ 3 (*) @@ -40,7 +36,8 @@ distributions. To install the rest, run: 1. Install the dependencies listed above. 2. Clone this repository. 3. Add the script as a startup application. (Use option `--short` for short - appearance if desired.) + appearance; use option `--order` to customize the order of the locks + displayed. See [Examples](#examples)) 4. Run the script manually for the first time. (Alternatively, log out and log in again.) 5. The indicator should be shown at the top right corner, with a filled circle @@ -49,6 +46,32 @@ distributions. To install the rest, run: 6. Clicking on the indicator should result in a menu with the three locks. Clicking on the menu item would cause the corresponding lock to toggle. +## Examples + +![indicator default][sc1] +Default appearance. `python3 indicator-keyboard-led.py` + +![indicator short][sc3] +Short appearance. `python3 indicator-keyboard-led.py --short` + +![indicator CNS][sc4] +Order changed to Caps Num Scroll. +`python3 indicator-keyboard-led.py --order CNS` + +![indicator NC][sc5] +Hide Scroll lock. `python3 indicator-keyboard-led.py --order NC` + +![indicator C short][sc6] +Show Caps lock only, short appearance. +`python3 indicator-keyboard-led.py --short --order C` + +[sc1]: screenshots/sc1.png +[sc2]: screenshots/sc2.png +[sc3]: screenshots/sc3.png +[sc4]: screenshots/sc4.png +[sc5]: screenshots/sc5.png +[sc6]: screenshots/sc6.png + ## Known bugs It seems to be a common problem that Scroll Lock is not usable in Ubuntu.