Stacklet

Stacklet allows you to create custom menus and applets using the standard output of any program, script, or executable.

Table of Contents

• Usage
• Installation
• For NixOS Users
• For Archlinux Users
• Building from Source
• 1. Setup with Nix
• 1. Setup for Everybody Else
• 2. Running with Cargo

Usage

Installation

Stacklet is available in both the NUR and the AUR.

For NixOS Users

Install from the NUR Stacklet Namespace using the method of your choice:

$ nix-shell -p nur.repos.ggemre.stacklet

or

$ nix-env -f '<nixpkgs>' -iA nur.repos.ggemre.stacklet

or

# configuration.nix
environment.systemPackages = with pkgs; [
  nur.repos.ggemre.stacklet
];

For help on setting up the NUR on your machine, see the Nix Community NUR How to Guide.

For Archlinux Users

Install from the AUR Stacklet Entry using the AUR helper of your choice:

For example:

yay -S stacklet

Building from Source

Begin by cloning this repository:

git clone https://github.com/ggemre/stacklet.git

In order to build Stacklet from source, you must have the necessary build dependencies installed. There are two approaches to achieving this depending on if you use Nix or not:

1. Setup with Nix

If you use Nix, (you are on NixOS or use the Nix package manager), then this is trivial thanks to the provided shell.nix and .envrc files, which will setup an ephemeral development environment with everything you need in the repository once you allow it do so:

direnv allow

1. Setup for everybody else

If you do not use Nix, the following build dependencies must be installed:

rustup
ncurses

Please use the stable branch of rust, (rustup default stable).

2. Running with Cargo

With the environment setup, Stacklet can be run from Cargo like so:

cargo run -- --version

or packaged with Cargo:

cargo build --release --locked

This built binary will be in target/release.