Skip to content

Commit bc22e20

Browse files
committed
docs: Cleanup wording
1 parent 6e91b2d commit bc22e20

File tree

2 files changed

+22
-36
lines changed

2 files changed

+22
-36
lines changed

README.md

Lines changed: 17 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,34 @@
22

33
System for choosing default applications, programs, and utilities
44

5-
Like `update-alternatives`, but local to user and more flexible. Requires a database of applications and their defaults at `"${XDG_CONFIG_HOME:-$HOME/.config}/chooses/defaults"`
6-
7-
## Summary
8-
9-
- Default application manager
10-
- Double click on file / launch with xdg-open, we control that
11-
- Abstract image/png, image/jpeg etc. behind 'image-viewer'. associate with single app at a time
12-
- Default application exec
13-
- Execute command associated with utility (ex. 'image-viewer's)
14-
15-
## Installation
16-
17-
Use [Basalt](https://github.com/hyperupcall/basalt), a Bash package manager, to install this project globally
18-
19-
```sh
20-
basalt global add hyperupcall/choose
21-
```
5+
## Use Cases
226

23-
## Environment Variables
24-
25-
- CHOOSE_DB_DIR
26-
- by default at `$XDG_CONFIG_HOME/choose/db`
7+
Like `update-alternatives`, but local to user and more flexible. Requires a database of applications and their defaults at `"${XDG_CONFIG_HOME:-$HOME/.config}/chooses/defaults"`
278

28-
## Folder Structure
9+
1. Launch with file
2910

30-
The author's config can be found [here](https://github.com/hyperupcall/dots/tree/main/user/.config/choose/db)
31-
- db
11+
Control which applications are selected when opening a file. This works irrespective of the desktop environment. `xdg-open` falls flat because it doesn't work with directories. Furthermore, different applications can be configured to work in a different context (X, Terminal emulator, Linux console).
3212

33-
- terminal-emulator
13+
Since these are just shell scripts, arbitrary arguments should be supported, like `--column` and `--row` for example, if using a text editor.
3414

35-
- alacritty
36-
- kitty
37-
- launch.sh
38-
- set.sh
39-
- get.sh
40-
- termite
15+
2. Launch without file
4116

42-
- launch.sh
43-
- set.sh
44-
- get.sh
17+
The current 'Browser' or 'Image Viewer' can be launched. Again, this is intended to work across distributions and user interfaces.
4518

46-
- image-viewer
19+
See more info in [details.md](./docs/details.md)
4720

48-
## TODO
21+
## Roadmap
4922

5023
- 'get' subcommand
5124
- use choose when using fuzzer / filter (dmenu vs rofi -dmenu, etc.)
5225
- application categories standardizable?
5326
- new command
5427
- sourcing pre-exec does does output on --verbose flag (or another)
28+
29+
## Installation
30+
31+
Use [Basalt](https://github.com/hyperupcall/basalt), a Bash package manager, to install this project globally
32+
33+
```sh
34+
basalt global add hyperupcall/choose
35+
```

docs/details.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,8 @@ db
3030
- xmobar/
3131
- launch.sh
3232
```
33+
34+
## Environment Variables
35+
36+
- CHOOSE_DB_DIR
37+
- by default at `$XDG_CONFIG_HOME/choose/db`

0 commit comments

Comments
 (0)