nwg-shell/README.md

126 lines
6.0 KiB
Markdown
Raw Normal View History

2021-05-09 04:31:06 +03:00
# nwg-shell
2021-05-09 05:11:49 +03:00
2022-02-09 16:19:17 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-shell.svg)](https://repology.org/project/nwg-shell/versions)
2022-08-21 15:32:07 +03:00
**[Learn more about nwg-shell on the project website](https://nwg-piotr.github.io/nwg-shell).**
**Use [Discussions](https://github.com/nwg-piotr/nwg-shell/discussions) to see announcements, share ideas or ask for support.**
2021-05-09 05:57:28 +03:00
2022-07-20 13:52:08 +03:00
The installer provided in this repository pulls all the necessary dependencies, and preconfigures [4 desktop
styles](https://github.com/nwg-piotr/nwg-shell-config/blob/master/README.md#desktop-styles) for you to choose from. Each of them you can modify freely from the nwg-shell-config GUI. Or you may choose the 'Custom' preset to experiment with.
2021-05-10 00:06:34 +03:00
2022-07-20 13:52:08 +03:00
# Installation
2021-05-09 05:57:28 +03:00
2022-02-09 16:19:17 +03:00
[How to set up nwg-shell on minimal Arch Linux install in several simple steps](https://github.com/nwg-piotr/nwg-shell/wiki) - Wiki
2022-07-20 14:06:53 +03:00
# nwg-shell components:
2021-05-09 06:07:12 +03:00
2022-07-20 13:52:08 +03:00
## [nwg-shell-config](https://github.com/nwg-piotr/nwg-shell-config) (python)
2022-06-17 14:06:55 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-shell-config.svg)](https://repology.org/project/nwg-shell-config/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-shell/releases/latest)
2022-06-17 14:06:55 +03:00
2022-07-20 13:52:08 +03:00
## [nwg-panel](https://github.com/nwg-piotr/nwg-panel) (python)
2021-05-09 05:57:28 +03:00
2021-07-02 10:21:46 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-panel.svg)](https://repology.org/project/nwg-panel/versions)
2022-07-20 14:06:53 +03:00
- [Wiki](https://github.com/nwg-piotr/nwg-panel/wiki)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-panel/releases/latest)
2022-02-02 00:26:58 +03:00
2022-07-20 14:06:53 +03:00
## [nwg-drawer](https://github.com/nwg-piotr/nwg-drawer) (go)
2022-05-25 04:13:56 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-drawer.svg)](https://repology.org/project/nwg-drawer/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-drawer/releases/latest)
2022-05-25 04:13:56 +03:00
2022-07-20 14:06:53 +03:00
## [nwg-dock](https://github.com/nwg-piotr/nwg-dock) (go)
2021-05-09 05:57:28 +03:00
2021-07-02 10:21:46 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-dock.svg)](https://repology.org/project/nwg-dock/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-dock/releases/latest)
2021-05-10 01:19:58 +03:00
2022-07-20 14:06:53 +03:00
## [nwg-menu](https://github.com/nwg-piotr/nwg-menu) (go)
2021-05-09 06:07:12 +03:00
2021-07-02 10:21:46 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-menu.svg)](https://repology.org/project/nwg-menu/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-menu/releases/latest)
2021-05-10 01:25:19 +03:00
2022-07-20 14:06:53 +03:00
## [nwg-bar](https://github.com/nwg-piotr/nwg-bar) (go)
2021-07-01 03:12:07 +03:00
2021-07-02 10:21:46 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-bar.svg)](https://repology.org/project/nwg-bar/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-bar/releases/latest)
2021-07-01 03:12:07 +03:00
2022-07-20 14:06:53 +03:00
## [Azote](https://github.com/nwg-piotr/azote) (python)
2022-05-08 23:05:26 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/azote.svg)](https://repology.org/project/azote/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/azote/releases/latest)
2022-05-08 23:05:26 +03:00
2022-07-20 14:06:53 +03:00
## [nwg-displays](https://github.com/nwg-piotr/nwg-displays) (python)
2022-05-08 23:05:26 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-displays.svg)](https://repology.org/project/nwg-displays/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-displays/releases/latest)
2022-05-08 23:05:26 +03:00
2022-07-20 14:06:53 +03:00
## [nwg-look](https://github.com/nwg-piotr/nwg-look) (go)
2022-05-08 23:05:26 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-look.svg)](https://repology.org/project/nwg-look/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-look/releases/latest)
2022-05-08 23:05:26 +03:00
2022-07-20 14:06:53 +03:00
## [nwg-wrapper](https://github.com/nwg-piotr/nwg-wrapper) (python)
2021-07-11 15:56:40 +03:00
2021-07-11 16:51:30 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-wrapper.svg)](https://repology.org/project/nwg-wrapper/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/nwg-wrapper/releases/latest)
2021-07-11 15:56:40 +03:00
2022-07-20 14:06:53 +03:00
## [gopsuinfo](https://github.com/nwg-piotr/gopsuinfo) (go)
2021-05-09 05:57:28 +03:00
2021-07-02 10:21:46 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/gopsuinfo.svg)](https://repology.org/project/gopsuinfo/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/gopsuinfo/releases/latest)
2021-05-09 06:02:28 +03:00
2022-07-20 14:06:53 +03:00
## [autotiling](https://github.com/nwg-piotr/autotiling) (python)
2021-05-09 06:02:28 +03:00
2021-07-02 10:21:46 +03:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/autotiling.svg)](https://repology.org/project/autotiling/versions)
2022-07-20 13:52:08 +03:00
- [latest release](https://github.com/nwg-piotr/autotiling/releases/latest)
2022-01-18 02:22:25 +03:00
2022-07-20 14:06:53 +03:00
# Support for other WMs
2022-05-08 23:05:26 +03:00
This project is primarily aimed at sway. Some parts may work on other wlroots-based compositors. Some may even work on X11, but it's not the primary objective. Feel free to submit addons / improvements, but keep in mind that all the stuff **must** work on sway, and **may or may not** work elsewhere.
2022-07-20 14:06:53 +03:00
## Pull requests adding support for non-sway stuff
2022-05-08 23:05:26 +03:00
are welcome.
2022-07-20 14:06:53 +03:00
## Feature requests like "add <place_your_wm_here> support"
2022-05-08 23:05:26 +03:00
go to `/dev/null`.
2022-01-18 02:22:25 +03:00
2022-07-20 14:06:53 +03:00
# Contributions
2021-05-10 02:47:00 +03:00
2021-05-10 10:17:20 +03:00
If you like the idea of the GTK shell for sway, feel free to submit your improvements, new modules, plugins or standalone programs. Preferred languages are python and Go.
2021-05-10 02:47:00 +03:00
2021-05-10 10:17:20 +03:00
**Important: before you open a PR containing major changes to already existing programs, please (PLEASE!) open an issue to discuss what you're going to do.**
2022-07-20 14:06:53 +03:00
## Feedback
2021-05-10 10:17:20 +03:00
2022-06-17 14:25:09 +03:00
Bug reports and ideas are more than welcome. Please remember, however, that at this stage, most part of the shell is being developed by a single hobbyist,
who uses Arch Linux. Some issues specific to other environment, e.g. Debian, FreeBSD, are out of my range and need some Community commitment.
2021-05-10 02:47:00 +03:00
2022-07-20 14:06:53 +03:00
# Resources
2021-05-10 01:41:43 +03:00
2022-02-02 01:22:19 +03:00
The project logo has been created by [edskeye](https://github.com/edskeye). You'll find the basic svg file in the
2022-05-08 23:29:44 +03:00
[resources](https://github.com/nwg-piotr/nwg-shell-resources/tree/master/resources) repository. If you like the logo,
you may also like [nwg-shell wallpapers](https://github.com/nwg-piotr/nwg-shell-resources/tree/master/wallpapers).
2022-07-20 14:06:53 +03:00
The uglier ones were designed by me, and the prettier ones by [@badkarma](https://forum.archlabslinux.com/u/badkarma/summary). ;)
# 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
Copyright © 2000-2022 JetBrains s.r.o. JetBrains and the JetBrains logo are registered trademarks of JetBrains s.r.o.