eww/README.md
2021-06-03 15:14:30 +02:00

37 lines
1.3 KiB
Markdown

# Eww
<img src="./.github/EwwLogo.svg" height="100" align="left"/>
Elkowar&rsquo;s Wacky Widgets is a standalone widget system made in Rust that allows you to implement
your own, custom widgets in any window manager.
Documentation **and instructions on how to install** can be found [here](https://elkowar.github.io/eww/main).
## Configuration Rework - USER OPINIONS NEEDED
Currently, a rework of the configuration language is planned.
Please give your opinions in the [discussion post](https://github.com/elkowar/eww/discussions/171).
## Examples
* A basic bar, see [examples](./examples/eww-bar)
![Example 1](./examples/eww-bar/eww-bar.png)
* [Setup by Axarva](https://github.com/Axarva/dotfiles-2.0)
![Axarva-rice](https://raw.githubusercontent.com/Axarva/dotfiles-2.0/main/screenshots/center.png)
* [Setup by adi1090x](https://github.com/adi1090x/widgets)
![Nordic](https://raw.githubusercontent.com/adi1090x/widgets/main/previews/nordic.png)
## Contribewwting
If you want to contribute anything, like adding new widgets, features or subcommands (Including sample configs), you should definitely do so.
### Steps
1. Fork this repository
2. Install dependencies
3. Smash your head against the keyboard from frustration (coding is hard)
4. Open a pull request once you're finished