X-Git-Url: https://glassweightruler.freedombox.rocks/gitweb/xdg-ninja.git/blobdiff_plain/ac51baf6100c03ae58a3e1078816df08550b30cd..b6d3bc4e2f25365294a4bcd2ecebee64b919770c:/README.md diff --git a/README.md b/README.md index 1a00cec..81efa9b 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ A shell script which checks your _$HOME_ for unwanted files and directories. +

+ +

+ When it encounters a file it knows about, it will tell you whether it's possible to move this file to an appropriate location, and how to do it. Currently, a subset of the [arch wiki page on XDG_BASE_DIR](https://wiki.archlinux.org/title/XDG_Base_Directory) is implemented as configurations. @@ -15,6 +19,16 @@ Clone the repository somewhere, then run the _./xdg-ninja.sh_ script. This will run every test in the default configuration. +## Dependencies + +- [bash](https://repology.org/project/bash/packages), obviously +- [jq](https://repology.org/project/jq/packages) for parsing the json files + +### Optional + +- [glow](https://repology.org/project/glow/packages) for rendering markdown in the terminal +- [cabal](https://repology.org/project/cabal/packages) for compiling the helper program for creating configurations + ## Configuration The configuration is done in the _programs/_ directory.