Merge pull request #278 from pavelskipenes/pciutils

[xdg-ninja.git] / README.md

diff --git a/README.md b/README.md
index 1a00cecbcb03b1bfe05d0deb50c6bc208667b0f3..6c3bc5e4009e7d4c16b40ecfcf541a4836ebec5c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,57 +5,93 @@
 
 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://s11.gifyu.com/images/68747470733a2f2f73382e67696679752e636f6d2f696d616765732f5065656b2d323032322d30352d31332d31362d30372e676966.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.
 
 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
 
 
 ## Running
 

+### Using nix
+
+If you're using [nix](https://nixos.org) and have flakes turned on, you can just run the following command:
+```sh
+nix run github:b3nj5m1n/xdg-ninja
+```
+
+### Cloning Manually
+

 Clone the repository somewhere, then run the _./xdg-ninja.sh_ script.
 
 This will run every test in the default configuration.
 
 Clone the repository somewhere, then run the _./xdg-ninja.sh_ script.
 
 This will run every test in the default configuration.
 

+### Installing with Homebrew
+
+To install xdg-ninja with [Homebrew](https://brew.sh), run `brew install xdg-ninja` to install the script and all of its dependencies, then run the `xdg-ninja` command.
+
+## Dependencies
+
+- your favorite POSIX-compliant shell ([bash](https://repology.org/project/bash/packages), [zsh](https://repology.org/project/zsh/packages), [dash](https://repology.org/project/dash-shell/packages), ...)
+- [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 ([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
 
 ## Configuration
 

-The configuration is done in the _programs/_ directory.
+The configuration is done in the _programs/_ directory, which should be located in the same working directory as the xdg-ninja.sh script. This can be overriden with the `XN_PROGRAMS_DIR` environment variable.

 
 You define a program, and then a list of files and directories which this program ruthlessly puts into your _$HOME_ directory.
 
 For each file/directory, you specify if it can be (re)moved.
 
 
 You define a program, and then a list of files and directories which this program ruthlessly puts into your _$HOME_ directory.
 
 For each file/directory, you specify if it can be (re)moved.
 

-If this is the case, you also specify instructions on how to accomplish this in markdown.
+If this is the case, you also specify instructions on how to accomplish this in Markdown.

 
 Files in this directory can have any name, but using the name of the program is encouraged.
 
 ### Automatically Generating Configuration
 
 
 Files in this directory can have any name, but using the name of the program is encouraged.
 
 ### 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 bash to run the tests)
+You can download the _xdgnj_ executable from the releases page. Alternatively, you can use the nix flake or 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)
+
+Available commands:
+```sh
+xdgnj add # Adds a new configuration
+xdgnj prev programs/FILE.json # Preview the configuration for a program
+xdgnj edit programs/FILE.json # Edit the configuration for a program
+xdgnj run # Mostly the same as running the shell script
+```
+
+#### Using nix

 
 

-Run the following command:
-```bash
-cabal build
+If you're using [nix](https://nixos.org) and have flakes turned on, you can just run the following command:
+```sh
+nix run github:b3nj5m1n/xdg-ninja#xdgnj-bin ...

 ```
 
 ```
 

-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
 
 We're going to use _git_ as an example.
 
 
 ### Manually
 
 We're going to use _git_ as an example.
 

-It puts the file _.gitconfig_ into _$HOME.
+It puts the file _.gitconfig_ into _$HOME_.

 
 Luckily, the XDG spec is supported by git, so we can simply move the file to _XDG_CONFIG_HOME/git/config_.
 
 We can use that last sentence as our instructions. In this case, there are no newlines, so escaping this string for use in json is trivial, however, this is how you should generally approach it:
 
 Luckily, the XDG spec is supported by git, so we can simply move the file to _XDG_CONFIG_HOME/git/config_.
 
 We can use that last sentence as our instructions. In this case, there are no newlines, so escaping this string for use in json is trivial, however, this is how you should generally approach it:

-```bash
+```sh

 echo "Luckily, the XDG spec is supported by git, so we can simply move the file to _XDG_CONFIG_HOME/git/config_." | jq -aRs .
 ```
 
 Let's see what the output of this command looks like for something a little more sophisticated.
 Here's an example file:
 echo "Luckily, the XDG spec is supported by git, so we can simply move the file to _XDG_CONFIG_HOME/git/config_." | jq -aRs .
 ```
 
 Let's see what the output of this command looks like for something a little more sophisticated.
 Here's an example file:

-```bash
+```sh

 cat example.md
 ```
 ```
 cat example.md
 ```
 ```


@@ -64,7 +100,7 @@ Currently not fixable.
 _(But you can probably just delete the dir)_
 ```
 Here's what catting this file to the _jq_ command produces:
 _(But you can probably just delete the dir)_
 ```
 Here's what catting this file to the _jq_ command produces:

-```bash
+```sh

 cat example.md | jq -aRs .
 ```
 ```
 cat example.md | jq -aRs .
 ```
 ```


@@ -87,4 +123,4 @@ Now, we can assemble our final json file:
 
 Saving this as _git.json_ in the _programs/_ directory will result in the script picking it up and checking the file.
 
 
 Saving this as _git.json_ in the _programs/_ directory will result in the script picking it up and checking the file.
 

-If you've created a configuration for a file that isn't in the offical repository yet, make sure to create a pull request so that other people can benefit from it as well.
+If you've created a configuration for a file that isn't in the official repository yet, make sure to create a pull request so that other people can benefit from it as well.