Update README.md

This commit is contained in:
Piotr Miller 2021-05-10 08:56:33 +02:00 committed by GitHub
parent 2d53e4637e
commit 4685c6bb63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,7 +1,7 @@
# nwg-shell
This project is an attempt to create a GTK-based shell for [sway](https://github.com/swaywm/sway) Wayland compositor. It's aimed at those, who do not believe
that the point of a modern computer is to use less than 200 MiB RAM and 0.5% CPU. Those who don't want to stare solely at the terminal's black window.
that the rationale of the modern computer is to use less than 200 MiB RAM and 0.5% CPU. Those who don't want to stare solely at the terminal's black window.
The programs included in the project are to give you the freedom of choice what your desktop looks like.
![3.png](https://scrot.cloud/images/2021/05/09/3.png)
@ -13,20 +13,20 @@ Feel free to submit addons / improvements, but keep in mind that all the stuff *
## Components, as for now:
### [nwg-panel](https://github.com/nwg-piotr/nwg-panel)
### [nwg-panel](https://github.com/nwg-piotr/nwg-panel) (Python)
The panel is the central point of the project. At the moment it contains 9 modules: Clock, Controls, CustomButton, Executor, MenuStart, Playerctl,
Scratchpad, SwayTaskbar and SwayWorkspaces. The Executor module supports tint2-like executors, that allow to add user-defined features.
The MenuStart module adds support for the nwg-menu plugin.
### [nwg-launchers](https://github.com/nwg-piotr/nwg-launchers)
### [nwg-launchers](https://github.com/nwg-piotr/nwg-launchers) (C++)
This is a set of launchers: application grid, button bar and dmenu. Initially written in python, turned out to be too slow. I developed them from
scratch in C++, as my first, and probably the last C++ code. Thanks to Contributors, led by [@Siborgium](https://github.com/Siborgium), the code looks pretty well
now, but it's difficult to me to maintain. I'm not going to live long enough to learn C++ at last, so I think I'll code the grid and dmenu from scratch in golang
sooner or later.
### [nwg-dock](https://github.com/nwg-piotr/nwg-dock)
### [nwg-dock](https://github.com/nwg-piotr/nwg-dock) (Go)
Fully configurable dock written in Go. It features pinned buttons, task buttons, the workspace switcher and the launcher button. The latter by default starts
nwggrid (application grid) from nwg-launchers.
@ -34,7 +34,7 @@ nwggrid (application grid) from nwg-launchers.
<div align="center"><img src="https://scrot.cloud/images/2021/05/10/dock.png" width="400"/></div>
### [nwg-menu](https://github.com/nwg-piotr/nwg-menu)
### [nwg-menu](https://github.com/nwg-piotr/nwg-menu) (Go)
It's the MenuStart plugin to nwg-panel, written in Go. It displays the system menu with simplified [freedesktop main categories](https://specifications.freedesktop.org/menu-spec/latest/apa.html). It also provides the search entry,
to look for installed application on the basis of .desktop files, and for files in XDG user directories.
@ -44,18 +44,18 @@ restart and shutdown.
<div align="center"><img src="https://scrot.cloud/images/2021/05/10/menu.png" width="400"/></div>
### [Azote](https://github.com/nwg-piotr/azote)
### [Azote](https://github.com/nwg-piotr/azote) (Python)
Azote is a picture browser and background setter, as the frontend to the swaybg (sway/Wayland) and feh (X windows) commands. The user interface is being
developed with multi-headed setups in mind. Azote also includes several colour management tools.
<div align="center"><img src="https://scrot.cloud/images/2021/03/13/azote-1.9.0.png" width="400"/></div>
### [gopsuinfo](https://github.com/nwg-piotr/gopsuinfo)
### [gopsuinfo](https://github.com/nwg-piotr/gopsuinfo) (Go)
This command, based on the [gopsutil](https://github.com/shirou/gopsutil) Go module, produces text output to display system usage info in nwg-panel executors.
### [autotiling](https://github.com/nwg-piotr/autotiling)
### [autotiling](https://github.com/nwg-piotr/autotiling) (Python)
This script uses the [i3ipc-python library](https://github.com/altdesktop/i3ipc-python) to switch the layout splith/splitv depending on the currently focused
window dimensions. It works on both sway and i3 window managers. You may love it or hate it, but it's my must have.