X-Git-Url: https://glassweightruler.freedombox.rocks/gitweb/xdg-ninja.git/blobdiff_plain/23fd26f3af161e304bcab4c3d02efeb48bab09fd..4240a1b632ee5c3fa0bd88ea1e6225384fffebbc:/README.md diff --git a/README.md b/README.md index d4e3349..3834647 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,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. -Currently, a subset of the [arch wiki page on XDG_BASE_DIR](https://wiki.archlinux.org/title/XDG_Base_Directory) is implemented as configurations. +The configurations are from the [arch wiki page on XDG_BASE_DIR](https://wiki.archlinux.org/title/XDG_Base_Directory), [antidot](https://github.com/doron-cohen/antidot) (thanks to Scr0nch for writing a conversion tool), and contributed by other users. ## Running @@ -26,7 +26,7 @@ This will run every test in the default configuration. ### Optional -- [glow](https://repology.org/project/glow/packages) for rendering markdown in the terminal +- [glow](https://repology.org/project/glow/packages) for rendering markdown in the terminal ([bat](https://repology.org/project/bat-cat/packages) can be used as a fallback, but glows output is clearer and therefore recommended) - [cabal](https://repology.org/project/cabal/packages) for compiling the helper program for creating configurations ## Configuration @@ -47,13 +47,9 @@ You need _haskell_ and _cabal_ installed. (To be clear, this is just for a tool Run the following command: ```sh -cabal build +cabal run xdgnj add ``` -You should now have a binary which you can run. You'll find it in somewhere in _dist-newstyle/build_, for example in _dist-newstyle/build/x86_64-linux/ghc-9.0.2/add-program-0.1.0.0/x/add-program/build/add-program/add-program_. - -Execute this binary in this directory. It will guide you through the process. - ### Manually We're going to use _git_ as an example.