readme edits

This commit is contained in:
Emma Tebibyte 2022-11-08 01:16:23 -05:00
parent d3ca906f8f
commit 39ebeccf9f

View File

@ -7,28 +7,32 @@ send `image/jpeg` MIME type files to your image viewer.
## Installation
### Arch
### Arch Linux
I maintain a package [on the
AUR](https://aur.archlinux.org/packages/xdg-sanity).
### From Source
First, make sure you have `curl(1)` and `handlr(1)` installed. Then, clone this
repository and move the `xdg-sanity/` folder into `/etc` and `xdg-sanity.sh` to
`xdg-sanity` wherever your operating system stores locally-installed binaries.
This is usually `/usr/local/bin`. Make sure the installation location is in your
First, make sure you have `curl(1)`, `xdg-utils(1)` (or an alternative like
[handlr](https://github.com/chmln/handlr), and
[tomcat](https://git.tebibyte.media/emma/tomcat) installed. Then, clone this
repository and move the `xdg-sanity` binary wherever your operating system
stores locally-installed binaries. This is usually `/usr/local/bin` or
`$HOME/.local/bin` for your user. Make sure the installation location is in your
`$PATH`.
Create a `xdg-sanity.desktop` file either manually or with `gendesk(1)`,
Create an `xdg-sanity.desktop` file either manually or with `gendesk(1)`,
placing it, also, where your OS stores locally-installed `.desktop` files,
usually `/usr/local/applications`. Set your default web browser to that
`.desktop` file.
`.desktop` file with `xdg-settings(1)` or an equivalent.
Add your default web browser to `/etc/xdg-sanity/xdg-sanity.conf` so the
Add your default web browser to `$XDG_CONFIG_HOME/xdg-sanity.toml` so the
script can forward links to it.
### Usage
`xdg-sanity [RESOURCE]`
Open links from applications outside your web browser as normal. Alternatively,
you can call `xdg-sanity` directly with the only argument accepted being a URI.
you can call `xdg-sanity` directly with the only argument accepted being a URI.