diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000000..c9b457567a97 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# clevo-indicator-git +This is an Arch Linux package forked from SkyLandTW's repository that lets +you control the fan of Clevo laptops using reversed-engineering port +information from ECView. + +## Packages Used +libappindicator-gtk3 to display the tray icon (the tray icon doesn't show +up on KDE, tested on Arch Linux) + +## AUR link +https://aur.archlinux.org/packages/clevo-indicator-git/ + +### Install instructions +#### Build and Install from the AUR (Arch Linux) +```shell +sudo pacman -S clevo-indicator-git +``` + +This package pulls upstream git commits from the repository https://github.com/SkyLandTW/clevo-indicator. + +**WARNING: THIS METHOD MAY BE UNSTABLE OR BREAK AT ANY TIME** + +#### Build and Install from Source (Ubuntu/Arch Linux) + +```shell +sudo apt-get install libappindicator-gtk3 +git clone git@github.com:SkyLandTW/clevo-indicator.git +cd clevo-indicator +make install +``` + +## Command-line documentation +See the [DOCUMENTATION.md file](DOCUMENTATION.md). |