New readme

This commit is contained in:
synt-xerror
2026-02-17 16:52:03 -03:00
parent 18916e86cd
commit a78da65f0f
2 changed files with 47 additions and 18 deletions

47
README.md Normal file
View File

@@ -0,0 +1,47 @@
# task-cli.
# how to use:
1. clone this repo
2. cd to the repo directory
3. run "make"
4. run "make install" (as root)
5. then run "task"
to clean, run "make clean"
# commands:
## add
to add a new task. example:
```
task add "take a bath (please)"
```
## read
to read all your tasks
example:
```
task read
```
the output will look like:
```
0. [ ] take a bath please
```
## done
to mark a task as done
example:
```
task done 0
```
the output of `task read` will no longer print the task 0
---
please give a star if you like it :( i love you

View File

@@ -1,18 +0,0 @@
task-cli.
=========
how to use:
-----------
1. clone this repo
2. cd to the repo directory
3. run "make"
4. run "make install"
5. then run "task"
6. to clean, run "make clean"
commands:
---------
no commands yet