Update README

[xdg-ninja.git] / README.md

diff --git a/README.md b/README.md
index 44748d1e7d1f566bcee79c28943fba4263067bce..e0166d74ca9b7d536b85dbfa1a46b3b461e83dbc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@ 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.
+
 ## Configuration
 
 The configuration is done in the _programs/_ directory.
@@ -19,7 +21,20 @@ If this is the case, you also specify instructions on how to accomplish this in
 
 Files in this directory can have any name, but using the name of the program is encouraged.
 
-### Example
+### Automatically Generating Configuration
+
+You need _haskell_ and _cabal_ installed.
+
+Run the following command:
+```bash
+cabal build
+```
+
+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.