kacper/td
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme adjustment

Browse Source
This commit is contained in:
Kacper Marzecki 2025-03-20 22:03:27 +01:00
parent 234e3d6efc
commit de1a711bd8
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
readme.md
View File

@ -6,16 +6,22 @@ $ npm install --global td
``` ```
# Dependencies # Dependencies
fzf https://github.com/junegunn/fzf - fzf https://github.com/junegunn/fzf
for searching & selectors - for searching & selectors
tmux
for displaying an editor in a side pane - tmux https://github.com/tmux/tmux/wiki
IMPORTANT: this must be run inside tmux - for displaying an editor in a side pane
Ive got a comfy tmux config I can share later if U'd want it :) - 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 # ENV vars
TD_EDITOR 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 :))) 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 TD_TASK_DIR
Directory for storing tasks.json and logs. Assumed to be a git repo 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 or in Your .bashrc
# Manual # 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**: 1. **Task Management**:
- Create, edit, delete tasks. - Create, edit, delete tasks.