README.md

AwesomeWM Memory Notifier plug-in

Simple and minimalistic Memory (RAM) notifier for AwesomeWM. Using Wibox widget piechart to display memory usage in GB and percentage.

RAM notifier plugin code was initially based on deficient/calendar, displaying a small text using Naughty.

Later it evolved into a pie chart notification using streetturtle implementation as an inspiration.

Installation

Drop the plugin code into your AwesomeWM config folder. e.g.:

[[ -d ~/.config/awesome/plugins ]] || mkdir ~/.config/awesome/plugins
cd ~/.config/awesome/plugins
git clone https://github.com/macunha1/awesomewm-memory-notifier ~/.config/awesome/plugins/memory-notifier

If your AwesomeWM config is a git repository, you can add as a submodule with

cd ~/.config/awesome

git submodule add -b master \
    -f --name memory-plugin \
    https://github.com/macunha1/awesomewm-memory-notifier \
    plugins/memory-notifier

git submodule sync --recursive .

Usage

And then import the plugin into your rc.lua:

-- load the widget code
local memory_widget = require("plugins.memory-notifier")

-- attach it as popup to your memory widget:
mem_widget({
    colors = {
        theme.fg_focus,
        theme.bg_normal,
        theme.fg_normal,
    },
    font  = theme.font, -- not supported
    fg    = theme.fg_normal,
    bg    = theme.bg_focus,

    border_width = theme.border_width,
    border_color = theme.border_color
}):attach(ram_wid)

Requirements

• awesome 4.0. May work on 3.5 with minor changes.