README.md

# wldash

A dashboard/launcher/control-panel thing for Wayland. Requires wlr-layer-shell-unstable-v1.

Consider this alpha-quality: While it works, *everything* is subject to change with a moments notice. You may end up pulling in the latest changes, and *poof*, wldash suddenly turns into an artisan espresso machine.

## Features

### Date and time

In nice, big letters!

### 3 month calendar

Scroll or click on the months to navigate.

### Battery level

Over upower, only visible if upower battery is detected

### Audio volume

Over pulseaudio, only visible if pulseaudio connection is successful. Scroll to adjust volume, right-click to toggle mute.

### Backlight control

Using backlight sys file, only visible of backlight is detected. Scroll to adjust, right-click to toggle between the extreme values.

### Launcher

Works like bemenu: pipe a list into wldash, and it will print out the selection made. Use https://github.com/kennylevinsen/dot-desktop if you want to launch using desktop files.

## Notable missing features:

- Scaling of any kind - all sizes are currently hardcoded in pixels
- Configurability
- Cleanup and reorganization
Add README 2019-08-02 15:59:38 +02:00			`# wldash`

Add protocol notice to README.md 2019-08-04 14:11:05 +02:00			`A dashboard/launcher/control-panel thing for Wayland. Requires wlr-layer-shell-unstable-v1.`
Add README 2019-08-02 15:59:38 +02:00
Update README.md 2019-08-02 17:30:18 +02:00			`Consider this alpha-quality: While it works, everything is subject to change with a moments notice. You may end up pulling in the latest changes, and poof, wldash suddenly turns into an artisan espresso machine.`

Add README 2019-08-02 15:59:38 +02:00			`## Features`

Update README.md 2019-08-02 17:21:03 +02:00			`### Date and time`
Add README 2019-08-02 15:59:38 +02:00
Update README.md 2019-08-02 17:21:03 +02:00			`In nice, big letters!`

			`### 3 month calendar`
Add README 2019-08-02 15:59:38 +02:00
calendar: Slow down scroll, add click navigation 2019-08-03 01:14:57 +02:00			`Scroll or click on the months to navigate.`
Add README 2019-08-02 15:59:38 +02:00
Update README.md 2019-08-02 17:21:03 +02:00			`### Battery level`
Add README 2019-08-02 15:59:38 +02:00
			`Over upower, only visible if upower battery is detected`

Update README.md 2019-08-02 17:21:03 +02:00			`### Audio volume`
Add README 2019-08-02 15:59:38 +02:00
			`Over pulseaudio, only visible if pulseaudio connection is successful. Scroll to adjust volume, right-click to toggle mute.`

Update README.md 2019-08-02 17:21:03 +02:00			`### Backlight control`
Add README 2019-08-02 15:59:38 +02:00
			`Using backlight sys file, only visible of backlight is detected. Scroll to adjust, right-click to toggle between the extreme values.`

Update README.md 2019-08-02 17:21:03 +02:00			`### Launcher`
Add README 2019-08-02 15:59:38 +02:00
			`Works like bemenu: pipe a list into wldash, and it will print out the selection made. Use https://github.com/kennylevinsen/dot-desktop if you want to launch using desktop files.`

			`## Notable missing features:`

			`- Scaling of any kind - all sizes are currently hardcoded in pixels`
			`- Configurability`
Update README.md 2019-08-02 17:21:03 +02:00			`- Cleanup and reorganization`