docs: update readme

This commit is contained in:
Anish Lakhwara 2024-05-19 22:07:12 -07:00
parent 6f367619c3
commit ffb5389f6b

17
README
View file

@ -19,15 +19,24 @@ Designed to help you overcome being overwhelmed
= Roadmap / Issues = = Roadmap / Issues =
- Implement state machine to manage state (See design docs) - Implement state machine to manage state (See design docs)
- Implement timer - Timer spinner
- It should have big full screen countdown MM:SS - Timer counts down
- Ideally the individual digits are ascii art made from the digit itself - Task marked as `start`ed once timer begins
- Ask if task completed on end of timer
- Set break timer
- Loop continues once break is completed
- TaskList Active tasks should _always_ display, and then let the cursor indexing kick in - TaskList Active tasks should _always_ display, and then let the cursor indexing kick in
- Full screen application
- Dynamic column spacing based on WindowResizeMsg - Dynamic column spacing based on WindowResizeMsg
- When going from TaskList to nvim, don't overwrite! Ask! - When going from TaskList to nvim, don't overwrite! Ask!
- Show hints about actions / shortcuts on screen - Show hints about actions / shortcuts on screen (help information)
- Refactor extra functions out of `main.go` and into `task.go` - Refactor extra functions out of `main.go` and into `task.go`
- Make sure task loading happens through `tea.Cmd` - Make sure task loading happens through `tea.Cmd`
- Set up debugging environment?
= Associated Tooling =
When developing this I also realized I need associated tooling to help manage my backlog more generally.
Similar to how I have a task selection section here, for which tasks will be active, I think I also want a backlogger and de-backlogger, for putting things into and out of my backlog easily. I was thinking that things that get backlogged in this way should also get a `recently backlogged` tag or something so that I can sort them easily, but then I thought there should also be a script which removes the recently tag after some time, and then I wondered if I'm just over engineering this for no fucking reason, I don't need cascading backlogs???
= Design Docs = = Design Docs =
- [Excalidraw drawings](https://excalidraw.com/#json=Tucrdp__TOwmtOEvNnbVv,ep_J-9-vB3BRVjnd0Y2H0w) - [Excalidraw drawings](https://excalidraw.com/#json=Tucrdp__TOwmtOEvNnbVv,ep_J-9-vB3BRVjnd0Y2H0w)