Mirrors/gBar
1
0
Fork 0
mirror of https://github.com/scorpion-26/gBar.git synced 2024-11-22 03:02:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fixup README

Browse source
This commit is contained in:
scorpion-26 2023-01-13 16:31:34 +01:00 committed by GitHub
parent 1bc74fa840
commit 8b88051659
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -14,6 +14,7 @@ My personal blazingly fast and efficient status bar + widgets, in case anyone fi
## Building and installation ## Building and installation
1. Configure with meson 1. Configure with meson
*All optional dependencies enabled* *All optional dependencies enabled*
``` ```
meson build --buildtype=release meson build --buildtype=release
@ -43,10 +44,34 @@ gBar audio [monitor]
## Gallery ## Gallery
![The bar with default css](/assets/bar.png) ![The bar with default css](/assets/bar.png)
*Bar with default css* *Bar with default css*
![The audio flyin with default css](/assets/audioflyin.png) ![The audio flyin with default css](/assets/audioflyin.png)
*Audio widget with default css* *Audio widget with default css*
## Features / Widgets
Bar:
- Workspaces (Hyprland only)
- Time
- Bluetooth (BlueZ only)
- Audio control
- Power control
- Shutdown
- Restart
- Suspend
- Lock (Requires manual setup, see FAQ)
- Exit/Logout (Hyprland only)
- CPU stats: Utilisation, temperature (Temperature requires manual setup, see FAQ)
- RAM: Utilisation
- GPU stats (Nvidia only): Utilisation, temperature, VRAM
- Disk: Free/Total
Audio Flyin:
- Audio control
## FAQ ## FAQ
### There are already many GTK bars out there, why not use them? ### There are already many GTK bars out there, why not use them?
- Waybar: - Waybar:
@ -64,6 +89,7 @@ The colors are from the Dracula theme: https://draculatheme.com
### I want to customize the colors ### I want to customize the colors
If you have SASS installed: Edit ~/.config/gBar/style.scss and regenerate style.css with it If you have SASS installed: Edit ~/.config/gBar/style.scss and regenerate style.css with it
Else: Edit ~/.config/gBar/style.css directly! Else: Edit ~/.config/gBar/style.css directly!
### I want to modify the widgets behaviour/Add my own widgets ### I want to modify the widgets behaviour/Add my own widgets
@ -75,7 +101,9 @@ This happens, when you kill the widget before it closes automatically after a fe
### CPU Temperature is wrong/Lock doesn't work ### CPU Temperature is wrong/Lock doesn't work
*This is caused by the way my system and/or Linux is setup.* *This is caused by the way my system and/or Linux is setup.*
Temperature: Edit the variable ```tempFilePath``` in ```src/System.cpp``` to the correct thermal zone file and recompile. The one for my system is *very* likely wrong. Temperature: Edit the variable ```tempFilePath``` in ```src/System.cpp``` to the correct thermal zone file and recompile. The one for my system is *very* likely wrong.
Lock: There is no generic way to lock a system. So please, implement it to suit your needs (Replace XXX by a shell command in ```src/System.cpp```) Lock: There is no generic way to lock a system. So please, implement it to suit your needs (Replace XXX by a shell command in ```src/System.cpp```)
### The icons are not showing! ### The icons are not showing!