From 965473c87b3dc538de9a68d357be45dc7e080b51 Mon Sep 17 00:00:00 2001
From: augustin64 <me.git@augustin64.fr>
Date: Wed, 12 Jul 2023 22:55:38 +0200
Subject: [PATCH] Add README.md

---
 Makefile             |  6 ++++++
 README.md            | 32 ++++++++++++++++++++++++++++++++
 src/include/config.h |  2 +-
 3 files changed, 39 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/Makefile b/Makefile
index 57b59f2..f84eb59 100644
--- a/Makefile
+++ b/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
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..71ee0b2
--- /dev/null
+++ b/README.md
@@ -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.
\ No newline at end of file
diff --git a/src/include/config.h b/src/include/config.h
index fead9da..4ab1a73 100644
--- a/src/include/config.h
+++ b/src/include/config.h
@@ -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"