eww README

The project's README from github.com/elkowar/eww. As one markdown file: README.md.

dependency status

Eww

Elkowars 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.

Dharmx also wrote a nice, beginner friendly introductory guide for eww here.

Check out another cool project by me

I'm currently busy working yolk, which is a dotfile management solution that supports a unique spin on templating: templating without template files.

To find out more, check out the website and documentation!

Examples

(Note that some of these still make use of the old configuration syntax.)

Rxyhn-rice

eww-top-bar

Activate Linux

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. Write down your changes in CHANGELOG.md
  5. Open a pull request once you're finished

Widget

https://en.wikipedia.org/wiki/Wikipedia:Widget

eww (elkowar/eww)

Searching Database…

12.7K ·GitHub
What is this?Eww (ElKowars Wacky Widgets) is a standalone widget system written in Rust that lets you build your own custom desktop widgets, like bars or system trackers, for any window manager.
Is this a GTK app I configure, or a Rust library I write code against?It's a standalone application (built on GTK) that you configure rather than a library you program in Rust; you write widget configs and run the eww binary, not Rust code.
How do I get eww running?The README doesn't give install commands directly; it points to a separate documentation site for install instructions, and since the whole codebase is Rust, you'd build it with Cargo.
Do I need GTK installed first?Yes, eww is built on GTK3 through gtk-rs, so you need a working GTK3 setup on your Linux machine before running or building it.
Will the example configs shown in the README just work?Not necessarily. The README itself warns that several of the showcased community setups still use eww's old configuration syntax, so copying them as-is may break on current versions.
Does it only work with tiling window managers like i3?No, eww is designed to be window-manager agnostic and work in any window manager, though many of the showcased example setups come from i3 and similar tiling WM users.
What is Yolk, the other project mentioned by the author?Yolk is the author's separate dotfile management tool, notable for templating dotfiles without needing dedicated template files. It's unrelated to eww itself, just a project by the same developer.
What kinds of widgets have people actually built with eww?The README links to community examples including basic and vertical status bars, an i3-bar replacement, and even a joke 'Activate Linux' watermark widget.
Creator
elkowar
Size
4.5 MB
Stars
12.7K
Age
6y
Commits · 90 Days