Skip to content

Commit

Permalink
update README.me
Browse files Browse the repository at this point in the history
  • Loading branch information
LBCrion committed Dec 24, 2020
1 parent 697743d commit abff71b
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# sfwbar
Sway Floating Window Bar
### SFWBar

SFWBar (Sway Floating Window Bar) is a flexible taskbar application for
[Sway](https://github.com/swaywm/sway) wayland
compositor, designed with a stacking layout in mind.

## SFWBar implements the following features:
1. Taskbar - to control floating windows
1. Window placement engine - to open new windows in more logical locations
1. A simple widget set to display information from system files

## Compiling from Source

Install dependencies:
glib
gtk3
gtk-layer-shell
json-c

Compile instructions:
meson build
ninja -C build

## Configuration
See man page for config file details

0 comments on commit abff71b

Please sign in to comment.