Update README with configuration details
This commit is contained in:
parent
2f19f9d1fb
commit
12c9c58ea4
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
@ -54,4 +54,16 @@ rofi-checklist stores the checklist in `~/.rofi-checklist` as a markdown-complia
|
||||||
- [ ] Go to bed
|
- [ ] Go to bed
|
||||||
```
|
```
|
||||||
|
|
||||||
This allows the checklist file to be used within other markdown editors. For example, you can make a symbolic link from `~/.rofi-checklist` to somewhere in your [Obsidian](https://obsidian.md/) vault — allowing a nice integration into your knowledge management software. If there's interest, support for configurable/multiple checklist file sources might be added in the future.
|
This allows the checklist file to be used within other markdown editors. For example, you can make a symbolic link from `~/.rofi-checklist` to somewhere in your [Obsidian](https://obsidian.md/) vault — allowing a nice integration into your knowledge management software.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
To configure rofi-checklist, create `~/.config/rofi-checklist.conf`. For example, the following changes the checklist file path and makes the checkboxes square instead of circular:
|
||||||
|
|
||||||
|
```SH
|
||||||
|
FILE=~/.rofi-checklist2
|
||||||
|
EMPTY=
|
||||||
|
FILLED=
|
||||||
|
```
|
||||||
|
|
||||||
|
Ability to switch between checklist files within rofi-checklist itself will be coming soon.
|
||||||
|
|
Reference in a new issue