Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
philer committed Mar 27, 2023
1 parent a911040 commit 34bc748
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ will assign an automatic amount of space, split evenly between this and other fl
The following Widget classes are currently available:

* **`Widget`** the base class - Does nothing by itself.
* **`Rows`** a container for multiple widgets to be rendered in a vertical stack - It is useful to subclass this in order to create compound widgets with a combined `:update()`.
* **`Rows`** a container for multiple widgets to be rendered in a vertical stack - It can also be useful to subclass this in order to create composite widgets with a combined `:update()` (see the implementation of `Drive` as an example).
* **`Columns`** like `Rows` but horizontal
* **`Filler`** Leave some empty space. Can also wrap another widget to restrict its size.
* **`Frame`** Provides background color, border, padding and margin for other Widgets.
Expand All @@ -69,7 +69,7 @@ The following Widget classes are currently available:
* **`Gpu`** Bars for GPU and VRAM usage - requires `nvidia-smi`
* **`GpuTop`** Show processes currently using the CPU.
* **`Network`** Graphs for up- and download speed - with space for conky.text in between.
* **`Drive`** Bar plus temperature indicator for a hard drive - requires hddtemp to be running and sudo access to nvme-cli for experimental NVME SSD support.
* **`Drive`** Bar plus temperature indicator for a HDD or SSD.

## Creating Widgets

Expand Down
4 changes: 2 additions & 2 deletions src/widget.lua
Original file line number Diff line number Diff line change
Expand Up @@ -473,8 +473,8 @@ local write_aligned = {left = ch.write_left,
-- @tparam ?string args.align "left" (default), "center" or "right"
-- @tparam[opt=w.default_font_family] ?string args.font_family
-- @tparam[opt=w.default_font_size] ?number args.font_size
-- @tparam[opt=CAIRO_FONT_WEIGHT_NORMAL] ?cairo_font_slant_t args.font_slant
-- @tparam[opt=CAIRO_FONT_SLANT_NORMAL] ?cairo_font_weight_t args.font_weight
-- @tparam[opt=CAIRO_FONT_SLANT_NORMAL] ?cairo_font_slant_t args.font_slant
-- @tparam[opt=CAIRO_FONT_WEIGHT_NORMAL] ?cairo_font_weight_t args.font_weight
-- @tparam ?{number,number,number,number} args.color (default: `default_text_color`)
function Text:init(args)
assert(getmetatable(self) ~= Text, "Cannot instanciate class Text directly.")
Expand Down

0 comments on commit 34bc748

Please sign in to comment.