Add README.md
This commit is contained in:
parent
3b9533929b
commit
965473c87b
6
Makefile
6
Makefile
@ -14,6 +14,12 @@ out/%.o: src/%.cpp
|
||||
takl: out/main.o out/db.o out/tasks.o
|
||||
$(CXX) $(FLAGS) $(LD_FLAGS) $^ -o $@
|
||||
|
||||
install: takl
|
||||
sudo cp takl /usr/bin/takl
|
||||
|
||||
uninstall: takl
|
||||
sudo rm /usr/bin/takl
|
||||
|
||||
clean:
|
||||
rm out -r
|
||||
rm ./takl
|
32
README.md
Normal file
32
README.md
Normal file
@ -0,0 +1,32 @@
|
||||
# TaKl
|
||||
|
||||
Ce petit programme a pour but d'être une todo-list intégrée au terminal,
|
||||
facile d'utilisation et donnant rapidement les choses demandées
|
||||
|
||||
### Installation
|
||||
|
||||
Les seules dépendances nécessaires sont `gcc` et `g++`.
|
||||
(Peut-être que des bibliothèques comme sqlite3 sont à installer sur certaines distributions/ OS)
|
||||
|
||||
```bash
|
||||
make -j # compilation
|
||||
make install # installation dans /usr/bin/takl
|
||||
```
|
||||
|
||||
Vous pouvez ensuite utiliser la commande `takl` pour ajouter/ modifier des items à la todo list.
|
||||
|
||||
|
||||
### Utilisation
|
||||
|
||||
```
|
||||
Utilisation: takl ( list | add | info | rm | done )
|
||||
list [-a:voir les tâches complétées]
|
||||
add <task> [date]
|
||||
Format de la date:
|
||||
Relatif: min+%d, h+%d, j+%d
|
||||
Absolu: dd/mm (pas de changement d'année pour l'instant)
|
||||
info <id1> <id2> ...
|
||||
done <id1> <id2> ...
|
||||
rm <id1> <id2> ...
|
||||
```
|
||||
Appeler l'exécutable sans arguments vous renverra cette petite liste de commandes que vous pouvez utiliser.
|
@ -1,7 +1,7 @@
|
||||
#ifndef DEF_CONFIG_H
|
||||
#define DEF_CONFIG_H
|
||||
|
||||
#define VERSION "0.0.0"
|
||||
#define VERSION "1.0.0"
|
||||
|
||||
// By default, $HOME/.config/takl.sqlite3 is used. You can change this behaviour here
|
||||
//#define DB_FILE "takl.sqlite3"
|
||||
|
Loading…
Reference in New Issue
Block a user