Actually exit when jq isn't installed

[xdg-ninja.git] / README.md

diff --git a/README.md b/README.md
index e0166d74ca9b7d536b85dbfa1a46b3b461e83dbc..81efa9bb8c98f691e1c03f3b09d065b5a554e05c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,10 +5,30 @@
 
 A shell script which checks your _$HOME_ for unwanted files and directories.
 
 
 A shell script which checks your _$HOME_ for unwanted files and directories.
 

+<p align="center">
+  <img src="https://s8.gifyu.com/images/Peek-2022-05-13-16-07.gif" width="500"/>
+</p>
+

 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.
 
 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.
 

+## Running
+
+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.
 ## Configuration
 
 The configuration is done in the _programs/_ directory.


@@ -23,7 +43,7 @@ Files in this directory can have any name, but using the name of the program is
 
 ### Automatically Generating Configuration
 
 
 ### Automatically Generating Configuration
 

-You need _haskell_ and _cabal_ installed.
+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 bash to run the tests)

 
 Run the following command:
 ```bash
 
 Run the following command:
 ```bash