2021-05-09 04:31:06 +03:00
# nwg-shell
2021-05-09 05:11:49 +03:00
2024-01-26 06:00:04 +03:00
< img src = "https://github.com/nwg-piotr/nwg-shell/assets/20579136/58e3dcc1-d738-449f-a6d0-e5cbb91e4e60" width = "60" style = "float:left;margin-right:10px;margin-bottom:10px" alt = "nwg-shell logo" >
2024-01-26 05:43:25 +03:00
2024-01-26 05:08:55 +03:00
**nwg-shell** is a GTK3-based shell for [sway ](https://github.com/swaywm/sway ) and
[Hyprland ](https://github.com/hyprwm/Hyprland ) Wayland compositors. The project provides a common configuration tool
2024-01-26 05:15:36 +03:00
(**nwg-shell-config**) that allows you to configure the system in a graphical UI, and a range of components such as
2024-01-26 05:08:55 +03:00
**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
2024-01-26 05:17:32 +03:00
**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),
2024-01-26 05:08:55 +03:00
**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
2024-01-26 05:13:08 +03:00
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.
2022-08-21 15:32:07 +03:00
2023-03-11 03:07:18 +03:00
Learn more about nwg-shell on the [**project website** ](https://nwg-piotr.github.io/nwg-shell ).
2021-05-09 05:57:28 +03:00
2024-01-26 05:08:55 +03:00
## Installation
2022-02-02 00:26:58 +03:00
2024-01-26 05:08:55 +03:00
For installation instructions, see the [Wiki page ](https://github.com/nwg-piotr/nwg-shell/wiki ).
2022-05-25 04:13:56 +03:00
2024-01-26 05:08:55 +03:00
[](https://repology.org/project/nwg-shell/versions)
2022-05-08 23:05:26 +03:00
2024-01-26 05:08:55 +03:00
## Contributing
2022-05-08 23:05:26 +03:00
2024-01-26 05:08:55 +03:00
Please read the [general contributing rules for the nwg-shell project ](https://nwg-piotr.github.io/nwg-shell/contribution ).
2022-05-08 23:05:26 +03:00
2024-01-26 05:48:20 +03:00
## License
The shell components are provided under the terms of the [MIT License ](https://github.com/nwg-piotr/nwg-shell/blob/main/LICENSE ),
unless otherwise specified for a certain component.
2024-01-26 05:08:55 +03:00
## Contact
2021-05-09 05:57:28 +03:00
2024-01-26 05:32:21 +03:00
- Use [Discussions ](https://github.com/nwg-piotr/nwg-shell/discussions ) to see CHANGELOG and announcements, share ideas, ask for support.
2024-01-26 05:26:46 +03:00
- Use [this invitation ](https://matrix.to/#/#nwg-shell:matrix.org ) to join the live chat on Matrix.
2021-07-02 10:21:46 +03:00
2024-01-26 05:08:55 +03:00
## Project supported by
2022-06-22 13:09:15 +03:00
2022-06-22 17:09:42 +03:00
< a href = "https://jb.gg/OpenSourceSupport" > < img width = "300" src = "https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt = "JetBrains Logo (Main) logo." > < / a >
2022-06-22 13:11:05 +03:00
2024-01-26 05:08:55 +03:00
Copyright © 2000-2024 JetBrains s.r.o. JetBrains and the JetBrains logo are registered trademarks of JetBrains s.r.o.
