24 lines
1.0 KiB
Markdown
24 lines
1.0 KiB
Markdown
# Codupoc
|
|
Codupoc is a proof of Concept for a TUI application called Codu. Codu will be a TUI-based application for managing todo
|
|
items in Markdown format.
|
|
|
|
## How it works
|
|
|
|
When you run Codupoc in a directory, it will look for a file called `todo.md` in that directory. If it does not find one,
|
|
you will be presented with an empty todo list. If Codupoc does find `todo.md` in the current directory, it will read
|
|
all Markdown checkboxes as Todo items. Here's an example:
|
|
|
|
```md
|
|
- [ ] An Incomplete Task
|
|
- [X] A Complete Task
|
|
```
|
|
|
|
Each line that matches this format will be read as a todo item. When an item is checked in Codupoc, the file will
|
|
automatically be updated to reflect the change.
|
|
|
|
You can add new todos by pressing `n` and typing the task description.
|
|
|
|
Codupoc is intended to be an extremely minimalistic Proof of Concept. The final version is planned to be written in Rust
|
|
and is planned to have significantly more robust error-handling. I may eventually add a calendar feature which allows
|
|
you to focus on tasks for specific days.
|