yafetch/README.md
Ari Archer 972c12a7a7
Make it available for the baz plugin manager
Signed-off-by: Ari Archer <ari.web.xyz@gmail.com>
2022-10-28 02:35:44 +03:00

1,012 B

This project is a fork of yrwq/yafetch with a different build system, more improvements and active porting to newer lua versions

Yafetch is a minimal command line system information tool written in C and configured in Lua.

Dependencies

  • a Linux distribution
  • a C compiler
  • Lua 5.4
  • (For NixOS) lorri

Documentation (Installation, Upgrading, etc.)

Docs

Usage

yafetch or yafetch <config.lua>

Configuration

Yafetch is extensible in lua, the default location for the config is ~/.config/yafetch/init.lua See Docs.

Testing

Requirements

  • Bash
  • Valgrind
  • Coreutils
  • Clang
  • GCC
  • Binutils
  • Lua 5.4

Testing

$ ./scripts/tests.sh

Warning

These tests are extremely slow and painful to do, so beware if you're running them in a CI environment or something of sort