chore(tasks): update instruction on using tasks on the readme
This commit is contained in:
parent
efbe556a6a
commit
36388ef5e5
1 changed files with 2 additions and 2 deletions
|
|
@ -26,11 +26,11 @@ $ cp example.conf ~/ayo.conf
|
||||||
|
|
||||||
## Tasks
|
## Tasks
|
||||||
|
|
||||||
The `task-tui` uses a `TASKS_HOME` variable in the configuration file. It looks for plain text files that follows the [template](./TASK_TEMPLATE.md).
|
The `task-tui` uses a `tasks_dir` variable in the configuration file. It looks for plain text files that follows the [template](./TASK_TEMPLATE.md).
|
||||||
|
|
||||||
The tasks text files need to be in one of the status directories: `backlog`, `next`, `in-progress`, or `done`.
|
The tasks text files need to be in one of the status directories: `backlog`, `next`, `in-progress`, or `done`.
|
||||||
|
|
||||||
After setting the `TASKS_HOME` variable in the configuration file `ayo.conf` and an alias to `ayo.sh` with `yo` in your `.bashrc` file, you can run the app with `yo tasks`.
|
After setting the `tasks_dir` variable in the configuration file `ayo.conf` and an alias to `ayo.sh` with `yo` in your `.bashrc` file, you can run the app with `yo tasks`.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue