https://github.com/ReadyWidgets/awesome-extrautils

A library providing many utility functions for use with the awesome window manager
https://github.com/ReadyWidgets/awesome-extrautils

List: awesome-extrautils

Last synced: 4 months ago
JSON representation

A library providing many utility functions for use with the awesome window manager

• Host: GitHub
• URL: https://github.com/ReadyWidgets/awesome-extrautils
• Owner: ReadyWidgets
• License: gpl-2.0
• Created: 2023-04-28T23:59:01.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-06-10T12:05:39.000Z (over 1 year ago)
• Last Synced: 2024-10-10T07:01:30.187Z (4 months ago)
• Language: Lua
• Size: 62.5 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-awesomewm-modules-widgets-and-libraries - awesome-extrautils
• awesome-awesomewm-modules-widgets-and-libraries - awesome-extrautils

README

        
# Awesome Extrautils

A library providing many utility functions for use with the Awesome window manager, which would not warrant their own repository.

# Compatibility

This library is designed for the Git master branch of Awesome. If you are stil using v4.3, you are highly encuraged to upgrade.

Additionally, this repository is currently only tested with Awesome compiled agains LuaJIT. It should also work with Lua 5.3, but it probably won't work for regular 5.1 (not that you should use a version released in Feb. 2006(!) with a bleeding-edge branch of Awesome (or really, at all), but still).

# Installation

> Note: `${XDG_CONFIG_HOME:-$HOME/.config}/awesome` usually unwraps to `~/.config/awesome`

First, clone this repositry by running the following in your terminal (`bash` or `zsh`):

```sh

git clone 'https://github.com/ReadyWidgets/awesome-extrautils' "${XDG_CONFIG_HOME:-$HOME/.config}/awesome/awesome-extrautils"

```

Next, edit your `rc.lua` to load Extrautils:

```lua

----------------------------------------------------------------

--- File: "${XDG_CONFIG_HOME:-$HOME/.config}/awesome/rc.lua" ---

----------------------------------------------------------------

--- Load Extrautils; notice the brackets at the end, you can pass a

--- custom path if you have them stored elsewhere.

local extrautils = require("extrautils")()

```