X-Git-Url: https://glassweightruler.freedombox.rocks/gitweb/xdg-ninja.git/blobdiff_plain/4402d2f7e32c8e4b6d157fbd093d017d9237bd8b..2c2d9fc4a2582730dae39f8cce8e02708938de34:/README.md

diff --git a/README.md b/README.md
index e0166d7..def4ddb 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,22 @@ When it encounters a file it knows about, it will tell you whether it's possible
 
 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.
@@ -23,7 +39,7 @@ 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.
+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