Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
elkowar committed Feb 10, 2021
1 parent 4da676e commit cddcea7
Show file tree
Hide file tree
Showing 3 changed files with 124 additions and 14 deletions.
106 changes: 106 additions & 0 deletions .github/EwwLogo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
![Eww logo](./.github/EwwGithubPreview.png)


# About
# Eww

Elkowar’s Wacky Widgets is a standalone Widget System made in rust to add AwesomeWM like widgets to any WM
<img src="./.github/EwwLogo.svg" height="100" align="left"/>

Documentation can be found [here](https://elkowar.github.io/eww/main)
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.

# Contribewwting
Documentation can be found [here](https://elkowar.github.io/eww/main).

If you want to contribute anything, like adding new widgets, features or subcommands (Including sample configs), you should definitly do so.
# Examples

## Steps
1. Fork this repo
2. Install dependencies
3. Smash your head against the keyboard from frustration (coding is hard)
4. Open a pull request once you're finished.
* A basic bar, see [examples](./examples/eww-bar)
![Example 1](./examples/eww-bar/eww-bar.png)

# Examples
* [Setup by Axarva](https://github.com/Axarva/dotfiles-2.0)
![Axarva-rice](https://raw.githubusercontent.com/Axarva/dotfiles-2.0/main/screenshots/center.png)

An example of an eww bar:

![Example 1](./examples/eww-bar/eww-bar.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
Binary file modified examples/eww-bar/eww-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cddcea7

Please sign in to comment.