Rename project to linux-utils, restructure & rewrite readme accordingly

This commit is contained in:
Reinout Meliesie 2026-05-14 12:27:42 +02:00
commit d69265c76a
Signed by: zedfrigg
GPG key ID: 3AFCC06481308BC6
6 changed files with 13 additions and 10 deletions

View file

@ -1,28 +1,31 @@
# Nix Packages
# Linux Utils
## Description
An assortment of Nix packages not in the official collection.
They can either be used individually or, if you're on NixOS, imported wholesale using the top-level module.
A packaged assortment of helpers for Arch Linux and NixOS.
## Structure
`PKGBUILD`
- Coming soon.
`nixos-module.nix`
- The top-level NixOS module containing all package expressions as an overlay, and all package modules.
Once imported the overlay contents can be found under `pkgs . kernelmaft`.
Once imported the overlay contents can be found under `pkgs`.
`packages/<package-name>/package.nix`
`<util-name>/package.nix`
- A Nix package expression.
`packages/<package-name>/nixos-module.nix`
`<util-name>/nixos-module.nix`
- NixOS module providing additional features for the package in question, such as for example systemd units.
Can be imported directly, but is also imported by the top-level module.
Not present for all packages.
## Examples
## Usage examples
> **Note:**
> You should replace the commits here with the latest one, or whichever one you want to use.
@ -43,7 +46,7 @@ Using a specific package expression:
```nix
pkgs.callPackage (import (pkgs.fetchurl {
url = "https://kernelmaft.com/forgejo/zedfrigg/nix-packages/raw/commit/c45884c66f31f8d8d80866bebc13e9e963e02a70/packages/python3.11-django-imagekit/package.nix";
url = "https://kernelmaft.com/forgejo/zedfrigg/nix-packages/raw/commit/c45884c66f31f8d8d80866bebc13e9e963e02a70/python3.11-django-imagekit/package.nix";
hash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
})) {}
```