pogmommy/eww
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Slightly clean up docs

Browse source
This commit is contained in:
elkowar 2021-05-14 20:07:47 +02:00
parent 4688f04cf3
commit e7a09dc571
No known key found for this signature in database
GPG key ID: E321AD71B1D1F27F
3 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/content/main/_index.md
View file

@ -40,6 +40,11 @@ and then to build:
```bash ```bash
cargo build --release cargo build --release
``` ```
**NOTE:**
When you're on wayland, build with:
```bash
cargo build --release --no-default-features --features=x11
```
### Running eww ### Running eww
Once you've built it you can now run it by entering: Once you've built it you can now run it by entering:

16
docs/content/main/troubleshooting.md
View file

@ -8,23 +8,33 @@ weight = 4
Here you will find help if something doesn't work, if the issue isn't listed here please [open an issue on the GitHub repo.](https://github.com/elkowar/eww/issues) Here you will find help if something doesn't work, if the issue isn't listed here please [open an issue on the GitHub repo.](https://github.com/elkowar/eww/issues)
### Eww does not compile
1. Make sure that you are compiling eww using the nightly rust toolchain.
2. Make sure you have all the necessary dependencies. If there are compile-errors, the compiler will tell you what you're missing.
### Eww does not work on wayland
1. Make sure you compiled eww with the `--no-default-features --feature=wayland` flags.
2. Make sure that you're not trying to use X11-specific features (these are (hopefully) explicitly specified as such in the documentation).
### My scss isn't being loaded! ### My scss isn't being loaded!
1. You have not created a scss file 1. You have not created a scss file
2. The scss file isn't called correctly. (it should be called `eww.scss` in the `$HOME/.config/eww` folder) 2. The scss file isn't called correctly. (it should be called `eww.scss` in the `$HOME/.config/eww` folder)
3. The scss file isn't placed in the correct location (check above) 3. The scss file isn't placed in the correct location (check above)
If none of these fixed your problem [open an issue on the GitHub repo.](https://github.com/elkowar/eww/issues) Or check the [GTK-Debugger](#gtk-debugger). If none of these fixed your problem [open an issue on the GitHub repo](https://github.com/elkowar/eww/issues), or check the [GTK-Debugger](@/main/working_with_gtk.md#gtk-debugger).
### Eww can't find my configuration file! ### Eww can't find my configuration file!
1. It's incorrectly named or it's in the wrong place (it should be called `eww.xml` in the `$HOME/.config/eww` folder) 1. It's incorrectly named or it's in the wrong place (it should be called `eww.xml` in the `$HOME/.config/eww` folder)
2. You haven't started eww correctly or you started it wrong. (See [Starting Eww](starting-eww)) 2. You haven't started eww correctly or you started it wrong.
### Something isn't styled correctly! ### Something isn't styled correctly!
1. You have mistyped the CSS class. 1. You have mistyped the CSS class.
2. Check the [GTK-Debugger](#gtk-debugger) 2. Check the [GTK-Debugger](@/main/working_with_gtk.md#gtk-debugger)
### General issues ### General issues

2
docs/content/main/working_with_gtk.md
View file

@ -18,7 +18,7 @@ If you have **NO** clue about how to do CSS, check out some online guides or tut
SCSS is _very_ close to CSS so if you know CSS you'll have no problem learning SCSS. SCSS is _very_ close to CSS so if you know CSS you'll have no problem learning SCSS.
### GTK-Debugger ### GTK-Debugger {#gtk-debugger}
The debugger can be used for **a lot** of things. Especially if something doesn't work or isn't styled right. to enable it launch your eww daemon with The debugger can be used for **a lot** of things. Especially if something doesn't work or isn't styled right. to enable it launch your eww daemon with