A Cleaner Readme
This commit is contained in:
parent
8467cf3fde
commit
1ac452ccca
1 changed files with 126 additions and 70 deletions
82
README.md
82
README.md
|
@ -1,14 +1,35 @@
|
||||||
# EWW - Elkowar's Wacky Widgets
|
|
||||||
|
|
||||||
## configuration
|
# Table of Contents
|
||||||
|
|
||||||
Eww's configuration should be placed in `~/.config/eww/eww.conf`.
|
* [About](#org4ab08b6)
|
||||||
any scss styles you want to add should be put into `~/.config/eww/eww.scss`.
|
* [Configuration](#org581ca61)
|
||||||
|
* [Example Config](#orgb769597)
|
||||||
|
* [Building](#orgbf66ce2)
|
||||||
|
* [Prerequisites](#org727b3da)
|
||||||
|
* [Installation](#orgdd31739)
|
||||||
|
* [Usage](#org4a9b3c6)
|
||||||
|
|
||||||
### Example configuration
|
|
||||||
|
|
||||||
```hocon
|
|
||||||
widgets: {
|
<a id="org4ab08b6"></a>
|
||||||
|
|
||||||
|
# About
|
||||||
|
|
||||||
|
Elkowar’s Wacky Widgets is a standalone Widget System made in rust to add AwesomeWM like widgets to any WM
|
||||||
|
|
||||||
|
|
||||||
|
<a id="org581ca61"></a>
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
|
||||||
|
Eww’s configuration should be placed in `~/.config/eww/eww.conf` and any `scss` styles you want to add should be put into `~/.config/eww/eww.scss`.
|
||||||
|
|
||||||
|
|
||||||
|
<a id="orgb769597"></a>
|
||||||
|
|
||||||
|
## Example Config
|
||||||
|
|
||||||
|
widgets: {
|
||||||
some_widget: {
|
some_widget: {
|
||||||
structure: {
|
structure: {
|
||||||
layout: {
|
layout: {
|
||||||
|
@ -60,12 +81,12 @@ widgets: {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
default_vars: {
|
default_vars: {
|
||||||
foo: 12
|
foo: 12
|
||||||
date: "neverrrr"
|
date: "neverrrr"
|
||||||
},
|
},
|
||||||
windows: {
|
windows: {
|
||||||
main_window: {
|
main_window: {
|
||||||
pos.x: 0
|
pos.x: 0
|
||||||
pos.y: 1080
|
pos.y: 1080
|
||||||
|
@ -77,5 +98,40 @@ windows: {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
|
||||||
|
|
||||||
|
<a id="orgbf66ce2"></a>
|
||||||
|
|
||||||
|
# Building
|
||||||
|
|
||||||
|
|
||||||
|
<a id="org727b3da"></a>
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- rustc
|
||||||
|
- cargo
|
||||||
|
|
||||||
|
Get them at <https://www.rust-lang.org/tools/install>
|
||||||
|
|
||||||
|
|
||||||
|
<a id="orgdd31739"></a>
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Build the Binary using -:
|
||||||
|
|
||||||
|
$ git clone https://github.com/Elkowar/eww.git
|
||||||
|
$ cd eww
|
||||||
|
$ cargo build --release
|
||||||
|
|
||||||
|
then copy the built binary from `./target/release` to anywhere in `$PATH` (example - `~/.local/bin`)
|
||||||
|
|
||||||
|
|
||||||
|
<a id="org4a9b3c6"></a>
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
Create a Config and then just do `eww`!
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue