readme adjustment
This commit is contained in:
parent
234e3d6efc
commit
de1a711bd8
20
readme.md
20
readme.md
@ -6,16 +6,22 @@ $ npm install --global td
|
||||
```
|
||||
|
||||
# Dependencies
|
||||
fzf https://github.com/junegunn/fzf
|
||||
for searching & selectors
|
||||
tmux
|
||||
for displaying an editor in a side pane
|
||||
IMPORTANT: this must be run inside tmux
|
||||
Ive got a comfy tmux config I can share later if U'd want it :)
|
||||
- fzf https://github.com/junegunn/fzf
|
||||
- for searching & selectors
|
||||
|
||||
- tmux https://github.com/tmux/tmux/wiki
|
||||
- for displaying an editor in a side pane
|
||||
- IMPORTANT: this app must be run inside tmux
|
||||
- Ive got a comfy tmux config I can share later if U'd want it :)
|
||||
|
||||
- OPTIONAL neovim https://github.com/neovim/neovim
|
||||
- rly not `dat bad` once u get used to it
|
||||
- https://www.lazyvim.org is an excellent starting point (da one I use still) but requires some more dependencies
|
||||
|
||||
# ENV vars
|
||||
TD_EDITOR
|
||||
Editor for ask editing, CLI only (recommend neovim (again Ive got a comfy config I can share later if U'd want it :)))
|
||||
can be set to e.g. `nano` or `vi` in a pinch
|
||||
TD_TASK_DIR
|
||||
Directory for storing tasks.json and logs. Assumed to be a git repo
|
||||
|
||||
@ -31,7 +37,7 @@ $ node dist/cli.js
|
||||
or in Your .bashrc
|
||||
|
||||
# Manual
|
||||
P.S. A more complete summary of keybinds can be displayed on `?` keybind
|
||||
P.S. A more complete (but dunno if complete) summary of keybinds can be displayed on `?` keybind
|
||||
|
||||
1. **Task Management**:
|
||||
- Create, edit, delete tasks.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user