mirror of https://github.com/nwg-piotr/nwg-shell.git synced 2024-07-14 17:30:29 +03:00

Installer & meta-package for the nwg-shell project: a GTK3-based shell for sway and Hyprland Wayland compositors

bar gtk gtk3 launcher menu panel starred-nwg-piotr-repo starred-repo sway wlroots

Go to file

piotr efdd4a3e7d update README.md		2024-01-26 04:00:53 +01:00
.github	Create FUNDING.yml	2022-12-15 11:28:43 +01:00
install	fix `yes_or_no` function	2023-06-20 02:42:39 +02:00
nwg_shell	set brightnessctl as default controller	2024-01-11 01:00:19 +01:00
scripts	scripts: screenshot: use `/usr/bin/env bash` as interpreter	2023-12-05 01:33:22 -06:00
.gitignore	remove folders moved to another repo	2022-02-04 12:48:15 +01:00
install.sh	add install script	2024-01-26 03:21:21 +01:00
LICENSE	update LICENSE	2024-01-26 03:22:15 +01:00
nwg-shell.jpg	change default wallpaper	2023-09-15 01:28:50 +02:00
README.md	update README.md	2024-01-26 04:00:53 +01:00
setup.py	bump to 0.5.27	2024-01-26 03:24:19 +01:00

README.md

nwg-shell

nwg-shell is a GTK3-based shell for sway and Hyprland Wayland compositors. The project provides a common configuration tool (nwg-shell-config) that allows you to configure the system in a graphical UI, and a range of components such as nwg-panel (system panel), nwg-drawer (application launcher), nwg-dock (system dock), nwg-menu (XDG-style menu) or nwg-bar (customizable button bar). It also includes several native tools as nwg-look (look and feel GTK settings editor), nwg-displays (display configuration tool), Azote (wallpaper manager), nwg-clipman (clipboard history manager), nwg-icon-picker (icon browser with textual search), nwg-readme-browser (documentation viewer) and nwg-hello (login manager). Scripts and utilities such as autotiling (script for sway to automatically switch the horizontal / vertical window split orientation) and gospuinfo (a command to display system usage info) are used in the background. The shell also utilizes third party software as swaync (notification center), gtklock / swaylock (screen lockers) and more. The nwg-shell package itself acts as a metapackage and installer of default configuration files.

Learn more about nwg-shell on the project website.

Installation

For installation instructions, see the Wiki page.

Contributing

Please read the general contributing rules for the nwg-shell project.

License

The shell components are provided under the terms of the MIT License, unless otherwise specified for a certain component.

Contact

Use Discussions to see CHANGELOG and announcements, share ideas, ask for support.
Use this invitation to join the live chat on Matrix.