From 3378ac399b27e4619e0350e6e296f7fc25f96ce3 Mon Sep 17 00:00:00 2001 From: iamcheeseman Date: Mon, 2 Mar 2026 14:14:31 +0100 Subject: fix grammatical and clarity issues in the README --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a21c1e5..b584ca7 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ # Description -A suckless statusbar for X11. +Tsarbar is 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. +And it only updates when you give it new data. # Installation -Run: +To install: ``` git clone https://codeberg.org/iamcheeseman/tsarbar cd tsarbar sudo make install ``` -To uninstall run: +To uninstall, run: ``` sudo make uninstall ``` @@ -21,8 +20,8 @@ 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. +You might notice it's not showing up, and that's 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] ``` @@ -40,21 +39,22 @@ tsarc config -[variable] [value] tsarc layout -[side] [component 1 2 ... n] -[side] [component 1 2 ... n] ... ``` -# Quick examples: +## 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. +Since that component doesn't 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. +This will configure the font to use Liberation Mono regular with a size of 9px. ``` -tsarc config -font "Liberation Mono:style=Regular:size=9" +tsarc config -font "Liberation Mono:style=Regular:pixelsize=9" ``` This will set the layout of the bar. -On the right, left and center there will be a previously set `label` component. +On the right, left, and center there will be a `label` component. +If these components do not have any text associated with them, they will not be rendered. ``` tsarc layout -left label -center label -right label ``` @@ -68,4 +68,3 @@ done ``` If our tsarbar has a component named `date` somewhere in the layout and this script is running. It will update the date to `$(date)`, this is a clock in our bar! -See `man date` for more info. -- cgit v1.3-2-g0d8e