X-Git-Url: https://glassweightruler.freedombox.rocks/gitweb/xdg-ninja.git/blobdiff_plain/c1dc6c9694ead574b9bea4040ed5bbbcaacbe26a..9e4a280f6ea3871feda68396c7d8e0b99df8096a:/README.md diff --git a/README.md b/README.md index d650c1f..9af8c77 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 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. @@ -36,6 +36,7 @@ To install xdg-ninja with [Homebrew](https://brew.sh), run `brew install xdg-nin - your favorite POSIX-compliant shell ([bash](https://repology.org/project/bash/packages), [zsh](https://repology.org/project/zsh/packages), [dash](https://repology.org/project/dash-shell/packages), ...) - [jq](https://repology.org/project/jq/packages) for parsing the json files +- [find](https://repology.org/project/findutils/versions) ### Optional @@ -43,7 +44,7 @@ To install xdg-ninja with [Homebrew](https://brew.sh), run `brew install xdg-nin ## Configuration -The configuration is done in the _programs/_ directory. +The configuration is done in the _programs/_ directory, which should be located in the same working directory as the xdg-ninja.sh script. This can be overriden with the `XN_PROGRAMS_DIR` environment variable. You define a program, and then a list of files and directories which this program ruthlessly puts into your _$HOME_ directory.