slstatus/README.md

51 lines
1.4 KiB
Markdown
Raw Normal View History

slstatus
========
2016-03-08 17:17:50 +00:00
**slstatus** is a suckless and lightweight status monitor for window managers which use WM_NAME as statusbar (e.g. DWM). It is written in pure C without any system() calls and only reads from files most of the time. It is meant as a better alternative to Bash scripts (inefficient) and Conky (bloated for this use).
The following information is included:
- wifi percentage
- battery percentage
- cpu usage in percent
- cpu temperature
- ram usage in percent
- alsa volume level in percent
2016-03-14 19:25:56 +00:00
- disk usage
- date
- time
Multiple entries (battery, wifi signal, ...) are supported and everything can be reordered and customized via a C header file (similar to DWM).
2016-03-08 17:17:50 +00:00
2016-03-08 17:18:47 +00:00
![screenshot](screenshot.png)
2016-03-08 17:17:50 +00:00
## Usage
2016-03-08 17:17:50 +00:00
### Installation
Before you continue, please be sure that a C compiler, `make` and `alsa-lib` are installed. Then compile the program once using `sudo make install`. After that you may change config.h to your needs and recompile it after any change!
2016-03-09 10:26:19 +00:00
### Starting
2016-03-10 06:51:04 +00:00
Put the following code in your ~/.xinitrc (or similar):
2016-03-10 06:51:04 +00:00
```
while true; do
slstatus
done &
```
The loop is needed that the program runs after suspend to ram.
## Contributing
In [TODO.md](TODO.md) there is a list of things that have to be done.
People who contributed are listed in [CONTRIBUTORS.md](CONTRIBUTORS.md).
2016-03-09 10:26:19 +00:00
For detailed information about coding style and restrictions see [CONTRIBUTING.md](CONTRIBUTING.md)
2016-03-10 17:01:39 +00:00
## License
2016-03-10 14:12:09 +00:00
2016-03-20 13:20:22 +00:00
See [LICENSE](LICENSE).