diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 76 |
1 files changed, 55 insertions, 21 deletions
@@ -1,26 +1,60 @@ -# To Do +# Workstack +A to-do manager for my specific needs. +Uses a stack to manage tasks where most important tasks or put at the top of the task. The +procastrination command can the put tasks at the bottom of the task. +For planned features see below. + +## Installation +### Dependencies +- `go` version 1.23.4 +### From my server +You can install from my git server with. +```sh +go install git.spacehb.net/ws.git/ws +``` +### Locally +Or locally if you have the repo downloaded. +```sh +git clone https://git.spacehb.net/ws ws +cd ws +go install ./ws +``` +# TODO: Features +- [ ] BUG: `ws nvim` remove description +- [ ] Debug flag for not messing my own `tasks.ws` file +- [ ] Default list improvements: + - Only list up to five active tasks + - those can be from different tasks + - We explicitly treat tasks from other tags as any task + - Do not show description on default list +- [ ] Multiple tags per task +- [ ] Done flag for `ws nvim` command - [ ] ZSH Completion -- [ ] import command -- [ ] better temp file path & delete on exit -- [ ] nvim command can edit done tasks as well (with flag) -- [ ] Add tore-like reminder for shellrc -- [ ] clocking with a 'start' command -- [ ] tag edit +- [ ] Clocking tasks a 'start' command to log when I worked on them +- [ ] Recurring tasks, such as routinely done tasks that need to be scheduled at intervals +- [ ] Provide an optional link for the tag, ex. youtube link, path on computer to pdf + - maybe we want to augment this with timestamp/page/scroll% information for bookmarking + in-progress tasks +- [ ] Make `ws nvim` into `ws edit` using the `$EDITOR` variable + +# TODO: GUI +It would be nice to have a GUI instead of the terminal text interface, because that interface is +rather limited. This could have features that would be complicated on the terminal like downloading +thumbnails for videos. -# Testing -- [ ] add -- [ ] done -- [ ] undo -- [ ] del -- [ ] pc -- [ ] <no arg> -- [ ] top -- [ ] ls -- [ ] list -- [ ] tag -- [ ] tag del -- [ ] tag add -- [ ] tag list +# TODO: Testing +- [ ] `ws add` +- [ ] `ws done` +- [ ] `ws undo` +- [ ] `ws del` +- [ ] `ws pc` +- [ ] `ws top` +- [ ] `ws` +- [ ] `ws list` +- [ ] `ws tag` +- [ ] `ws tag del` +- [ ] `ws tag add` +- [ ] `ws tag list` # Done - [x] Added nvim command |