Readme redesignt

This commit is contained in:
esche 2023-11-20 11:10:44 +01:00
parent 3be9274315
commit 86ba84e209

View file

@ -1,3 +1,5 @@
<img width=150 height=50 align=right src="https://archlinux.org/static/logos/archlinux-logo-light-1200dpi.7ccd81fd52dc.png">
# Sway-Config
My current SwayWM Setup for Arch Linux. It uses bash Skripts and systemd-utilities. If you want to use it without them, help me improve it. If you want just a full setup for sway-desktop, have a look at [nwg-shell](https://nwg-piotr.github.io/nwg-shell/) at first.
@ -8,40 +10,56 @@ My current SwayWM Setup for Arch Linux. It uses bash Skripts and systemd-utiliti
- many bindsyms ([neo2](https://www.neo-layout.org/) keyboard layout)
- already set up to support xwayland and wine (for wine also see [this issue](https://wiki.archlinux.org/title/Sway#Mouse_not_working_in_WINE_applications))
### Setting up
- install dependencies
### Installation
- install modules
- Place the files in .config in $XDG_CONFIG_HOME
- make shell-scripts executable ```chmod u+x .config/sway/*.sh```
- Make shell-scripts executable ```chmod u+x .config/sway/*.sh```
- edit the .config/sway/gammastep.ini to your timezone
- edit the Output and Input Configuration in .config/sway/config, if neccessary
- set Environment
- start sway
- further information can be found in the [sway wiki](https://github.com/swaywm/sway/wiki/Running-programs-natively-under-wayland)
### Dependencies:
- [alacritty](https://github.com/alacritty/alacritty)
- [wofi](https://hg.sr.ht/~scoopta/wofi)
- emoji-font (e.g. [noto-emoji](https://github.com/googlefonts/noto-emoji))
- [gammastep](https://gitlab.com/chinstrap/gammastep)
- [grim](https://sr.ht/~emersion/grim/)
- [mako](https://github.com/emersion/mako)
- [polkit-gnome](https://gitlab.gnome.org/Archive/policykit-gnome)
- [slurp](https://github.com/emersion/slurp)
- [acpiclient](https://sourceforge.net/projects/acpiclient/files/acpiclient/)
- [playerctl](https://github.com/altdesktop/playerctl)
### Modules and Dependencies
install all with: ```sudo pacman -Syu alacritty wofi noto-fonts-emoji gammastep grim mako polkit-gnome slurp acpi playerctl```\
optional: [xorg-xwayland](https://xorg.freedesktop.org/wiki/)
| **Module Type** | **Module Name** |
|:--------------------|:---------------------------------------------------------------------------------------------------------------------:|
| Shell | [GNU-bash](https://www.gnu.org/software/bash/bash.html) |
| Window Manager | [sway](https://github.com/swaywm/sway) |
| Notification Deamon | [mako](https://github.com/emersion/mako) |
| Screen Locker | [swaylock](https://github.com/swaywm/swaylock) |
| Idle Manager | [swayidle](https://github.com/swaywm/swayidle) |
| Gamma | [gammastep](https://gitlab.com/chinstrap/gammastep) |
| Screenshot | [grim](https://sr.ht/~emersion/grim/) |
| System Info Tool | [acpiclient](https://sourceforge.net/projects/acpiclient/files/acpiclient/), [neofetch](https://github.com/dylanaraps/neofetch)|
| Terminal Emulator | [alacritty](https://github.com/alacritty/alacritty) |
| App Launcher | [wofi](https://hg.sr.ht/~scoopta/wofi) |
| Symbols/Emojis | emoji-font (e.g. [noto-emoji](https://github.com/googlefonts/noto-emoji)) |
| polkit | [polkit-gnome](https://gitlab.gnome.org/Archive/policykit-gnome) |
| Screen Selector | [slurp](https://github.com/emersion/slurp) |
| Media Controls | [playerctl](https://github.com/altdesktop/playerctl) |
| X-Compatibility | [xorg-xwayland](https://xorg.freedesktop.org/wiki/) |
on Arch install all with: ```sudo pacman -Syu acpi alacritty bash gammastep grim mako neofetch noto-fonts-emoji playerctl polkit-gnome slurp sway swayidle swaylock wofi xorg-xwayland```
### Recommended Environment
These [Environment Variables](https://wiki.archlinux.org/title/Environment_Variables) are recommended for using sway:\
export XDG_CURRENT_DESKTOP=sway\
export XDG_SESSION_TYPE=wayland\
These are [Environment Variables](https://wiki.archlinux.org/title/Environment_Variables) I recommend for using sway:\
export XDG_SESSION_TYPE="wayland"
export XDG_CURRENT_DESKTOP=sway
export QT_QPA_PLATFORM="wayland;xcb"
export SDL_VIDEODRIVER="wayland,x11"
export _JAVA_AWT_WM_NONREPARENTING=1
export MOZ_ENABLE_WAYLAND=1
### Theming
For a consistent Theme across GTK and QT applications you can also set the Adwaita theme (libadwaita) which also has a adwaita-qt version in the AUR. Fontsettings can be done with [fontconfig](https://www.freedesktop.org/wiki/Software/fontconfig/).
A graphical Interface for this is [nwg-look](https://nwg-piotr.github.io/nwg-shell/nwg-look).
| **Module Type** | **Module Name** |
|:--------------------|:---------------------------------------------------------------------------------------------------------------------:|
| GTK Theme | [libadwaita](https://gnome.pages.gitlab.gnome.org/libadwaita/) |
| QT Theme | [adwaita-qt](https://github.com/FedoraQt/adwaita-qt) |
| Font Settings | [fontconfig](https://www.freedesktop.org/wiki/Software/fontconfig/) |
A graphical Interface for Theming is [nwg-look](https://nwg-piotr.github.io/nwg-shell/nwg-look).
### Licences
the wallpaper is "Winter Fairies" by David Revoy, licensed under Creative Commons Attribution 4.0.