Added dockerfile for xdgnj

[xdg-ninja.git] / README.md

diff --git a/README.md b/README.md
index d4e3349315d58fe4a047293e1a7dc431e76fa39a..1365abd198c4da08c9a83086a0f56c3276e1a577 100644 (file)
--- 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,8 +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
-- [cabal](https://repology.org/project/cabal/packages) for compiling the helper program for creating configurations
+- [glow](https://repology.org/project/glow/packages) for rendering markdown in the terminal ([bat](https://repology.org/project/bat-cat/packages), [pygmentize](https://repology.org/project/pygments/versions) or [highlight](https://repology.org/project/highlight/packages) can be used as fallback, but glow's output is clearer and therefore glow is recommended)
 
 ## Configuration
 
@@ -43,16 +42,18 @@ Files in this directory can have any name, but using the name of the program is
 
 ### Automatically Generating Configuration
 
-You need _haskell_ and _cabal_ installed. (To be clear, this is just for a tool that will help you automatically generate the config files, you still only need your shell to run the tests)
+You can download the _xdgnj_ executable from the releases page. Alternatively you can build it from scratch using _cabal_, _stack_, or the provided docker image in _build/_. (To be clear, this is just a tool that will help you automatically generate the config files, you still only need your shell to run the tests)
 
-Run the following command:
+Available commands:
 ```sh
-cabal build
+xdgnj add # Adds a new configuration
+xdgnj prev programs/FILE.json # Preview the configuration for a program
+xdgnj run # Mostly the same as running the shell script
 ```
 
-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_.
+#### Building from scratch
 
-Execute this binary in this directory. It will guide you through the process.
+You can use `cabal build`, `stack build`, or the provided dockerfile in _build/_.
 
 ### Manually