Added dockerfile for xdgnj

[xdg-ninja.git] / README.md

diff --git a/README.md b/README.md
index 3834647a03274eb8953d788042158bec5f156b84..1365abd198c4da08c9a83086a0f56c3276e1a577 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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 ([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
+- [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,13 +42,19 @@ 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 run xdgnj add
+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
 ```
 
+#### Building from scratch
+
+You can use `cabal build`, `stack build`, or the provided dockerfile in _build/_.
+
 ### Manually
 
 We're going to use _git_ as an example.