diff --git a/README.md b/README.md index 5fb5ecfa..67809c3f 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,10 @@ Ironbar is designed to support anything from a lightweight bar to a full desktop [![Packaging status](https://repology.org/badge/vertical-allrepos/ironbar.svg)](https://repology.org/project/ironbar/versions) +Ironbar can be installed from source or using your preferred package manager. + +It is also recommended to install a [Nerd Font](https://www.nerdfonts.com/#home) for displaying symbols. + ### Cargo [crate](https://crates.io/crates/ironbar) diff --git a/docs/Compiling.md b/docs/Compiling.md index 1e74c4a6..6b1c9a77 100644 --- a/docs/Compiling.md +++ b/docs/Compiling.md @@ -9,6 +9,8 @@ cargo build --release install target/release/ironbar ~/.local/bin/ironbar ``` +It is also recommended to install a [Nerd Font](https://www.nerdfonts.com/#home) for displaying symbols. + ## Build requirements To build from source, you must have GTK (>= 3.22) and GTK Layer Shell installed. diff --git a/docs/Configuration guide.md b/docs/Configuration guide.md index 7caeaf55..5edf0b19 100644 --- a/docs/Configuration guide.md +++ b/docs/Configuration guide.md @@ -9,6 +9,8 @@ If you want to see some ready-to-go config files check the [examples folder](https://github.com/JakeStanger/ironbar/tree/master/examples) and the example pages in the sidebar. +The examples make use of [Nerd Fonts](https://www.nerdfonts.com/#home) for displaying symbols. + ## 1. Create config file The config file lives inside the `ironbar` directory in your XDG_CONFIG_DIR, which is usually `~/.config/ironbar`. diff --git a/docs/modules/Upower.md b/docs/modules/Upower.md index e5db9aa0..620c3bd2 100644 --- a/docs/modules/Upower.md +++ b/docs/modules/Upower.md @@ -84,11 +84,10 @@ and will be replaced with values from the current battery state: | Selector | Description | |---------------------------------|--------------------------------| -| `.upower` | Upower widget container. | -| `.upower .button` | Upower widget button. | -| `.upower .button .contents` | Upower widget button contents. | -| `.upower .button .icon` | Upower widget battery icon. | -| `.upower .button .label` | Upower widget button label. | +| `.upower` | Upower widget button. | +| `.upower .contents` | Upower widget button contents. | +| `.upower .icon` | Upower widget battery icon. | +| `.upower .label` | Upower widget button label. | | `.popup-upower` | Upower popup box. | | `.popup-upower .upower-details` | Label inside the popup. | diff --git a/examples/config.corn b/examples/config.corn index 253444e1..03416d2c 100644 --- a/examples/config.corn +++ b/examples/config.corn @@ -55,7 +55,7 @@ let { interval.networks = 3 format = [ - " {cpu_percent}% | {temp_c:k10temp_Tccd1}°C" + " {cpu_percent}% | {temp_c:k10temp-Tccd1}°C" " {memory_used} / {memory_total} GB ({memory_percent}%)" "| {swap_used} / {swap_total} GB ({swap_percent}%)" "󰋊 {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)" diff --git a/examples/config.json b/examples/config.json index b984e5f9..a54dd128 100644 --- a/examples/config.json +++ b/examples/config.json @@ -63,7 +63,7 @@ "networks": 3 }, "format": [ - " {cpu_percent}% | {temp_c:k10temp_Tccd1}°C", + " {cpu_percent}% | {temp_c:k10temp-Tccd1}°C", " {memory_used} / {memory_total} GB ({memory_percent}%)", "| {swap_used} / {swap_total} GB ({swap_percent}%)", "󰋊 {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)", diff --git a/examples/config.toml b/examples/config.toml index 129d1bf8..540c0539 100644 --- a/examples/config.toml +++ b/examples/config.toml @@ -53,7 +53,7 @@ interval = 500 [[end]] type = "sys_info" format = [ - " {cpu_percent}% | {temp_c:k10temp_Tccd1}°C", + " {cpu_percent}% | {temp_c:k10temp-Tccd1}°C", " {memory_used} / {memory_total} GB ({memory_percent}%)", "| {swap_used} / {swap_total} GB ({swap_percent}%)", "󰋊 {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)", diff --git a/examples/config.yaml b/examples/config.yaml index cff29d5c..e05c4a19 100644 --- a/examples/config.yaml +++ b/examples/config.yaml @@ -43,7 +43,7 @@ end: disks: 300 networks: 3 format: - -  {cpu_percent}% | {temp_c:k10temp_Tccd1}°C + -  {cpu_percent}% | {temp_c:k10temp-Tccd1}°C -  {memory_used} / {memory_total} GB ({memory_percent}%) - '| {swap_used} / {swap_total} GB ({swap_percent}%)' - 󰋊 {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%) diff --git a/examples/test.corn b/examples/test.corn new file mode 100644 index 00000000..219e303d --- /dev/null +++ b/examples/test.corn @@ -0,0 +1,60 @@ +let { + $config_dir = "/home/jake/.config/ironbar" + + $workspaces = { type = "workspaces" } + $launcher = { type = "launcher" } + $volume = { + type = "volume" + format = "{icon} {percentage}%" + max_volume = 100 + icons.volume_high = "󰕾" + icons.volume_medium = "󰖀" + icons.volume_low = "󰕿" + icons.muted = "󰝟" + } + $network_manager = { type = "networkmanager" } + $clock = { + type = "clock" + // disable_popup = true + // format = "%d/%m/%Y %H:%M:%S" + } + $tray = { type = "tray" prefer_theme_icons = false } + + // $label = { type = "label" label = "hello" } + $label = { type = "label" label = "#random" } + $clipboard = { type = "clipboard" } + + $notifications = { + type = "notifications" + show_count = true + + icons.closed_none = "󰍥" + icons.closed_some = "󱥂" + icons.closed_dnd = "󱅯" + icons.open_none = "󰍡" + icons.open_some = "󱥁" + icons.open_dnd = "󱅮" + } + + $focused = { type = "focused" } + + $cairo = { type = "cairo" path = "$config_dir/clock.lua" frequency = 50 width = 300 height = 300 } + + $custom = { + type = "custom" + bar = [ { type = "button" on_click = "popup:toggle" widgets = [ $focused ] } ] + popup = [ { type = "box" orientation = "v" widgets = [ $clock $cairo ] } ] + } + + $mpris = { type = "music" } +} in { + // ironvar_defaults.color = "red" + + position = "bottom" + + icon_theme = "Paper" + + start = [ $workspaces $label ] + center = [ $custom ] + end = [ $notifications $clock ] +} \ No newline at end of file