diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8c6db5 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Description +A suckless statusbar for X11. + +It can draw text on the left, center and right part of the screen. +Text and background color of each component may be set individually. + +Only updates when you give it new data. + +# Installation +Run: +``` +git clone https://codeberg.org/iamcheeseman/tsarbar +cd tsarbar +sudo make install +``` +To uninstall run: +``` +sudo make uninstall +``` + +# Usage +Run the bar with `tsarbar`. + +You might notice it's not showing up, thats because we need to give it something to render. +This is done using `tsarc`, tsarc is a script that forwards data to tsarbar. +``` +tsarc [command] [args] +``` + +Available commands: +``` +# Variable is any of {text, foreground/fg, background/bg} +tsarc set [component] -[variable] [value] + +# Variable is any of {height, font, gap, padding, foreground/fg, background/bg} +tsarc config -[variable] [value] + +# Side is any of {left, center, right} +# Components 1 2 ... n are any components you previously set to +tsarc layout -[side] [component 1 2 ... n] -[side] [component 1 2 ... n] ... +``` + +# Quick examples: + +This will set the text value of the component `label` to `"Lorem ipsum"`. +Since that component doesnt exist yet, it will also implicitly create it. +``` +tsarc set label -text "Lorem ipsum" +``` + +This will configure the font to use Liberation mono regular with a size of 9px. +``` +tsarc config -font "Liberation Mono:style=Regular:size=9" +``` + +This will set the layout of the bar. +On the right, left and center there will be a previously set `label` component. +``` +tsarc layout -left label -center label -right label +``` |