kun

git clone git://bebou.netlib.re/kun
Log | Files | Refs | README |

commit 632f1ea0ec174faa65f428f3a0f16ba02b4c8bd6
parent 0fed6f9be3efebb75c75daa5ed282752b9083f3e
Auterice: Arthur Pons <arthur.pons@unistra.fr>
Date:   Thu, 19 Sep 2024 12:01:57 +0200

Ajout de documentation dans le README

Aussi, correction de l'aide après changement de nom du fichier
commands
$EDITOR plutôt que nano (hahaha, vim.)

Diffstat:
M
README
 | 
76
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
M
commands.sh
 | 
2
+-
M
kun.sh
 | 
2
+-

3 files changed, 77 insertions(+), 3 deletions(-)
diff --git a/README b/README
@@ -1 +1,75 @@
-Kun en TUI via SSH pour présentation aux journées de l'eco-conception
+# Kun
+
+Un outil de sondage très simple, sans authentification, accessible depuis un
+terminal. Deux modes d'interaction, TUI via des menus fzy ou en mode cli.
+
+Basé sur les idées détaillées dans [cet
+article](http://arthur.bebou.netlib.re/kun).
+
+## Installation
+
+Pour installer (sur un debian du moins) :
+
+	make
+	sudo make install
+
+## Dépendances
+
+  * un shell posix (testé avec dash)
+  * un éditeur de texte (celui par défaut dans $EDITOR
+  * [un fork multi-sélection de fzy]((https://github.com/leo-arch/fzy)
+
+## Utilisation
+
+Voir les commandes disponibles avec
+
+	./kun.sh -h
+
+	# créer un sondage
+	# kun create
+	create() {
+	--
+	# ajouter une réponse à un sondage
+	# kun addanswer id votre_nom
+	addanswer() {
+	--
+	# modifier une réponse existante
+	# n'est pas tant une "modification" qu'une réécriture
+	# kun modifyanswer id id_de_réponse
+	modifyanswer() {
+	--
+	# supprimer un sondage
+	# kun deletequestion id
+	deletequestion() {
+	--
+	# supprimer une réponse
+	# kun deleteanswer id id_réponse
+	deleteanswer() {
+	--
+	# voir les résultats d'une question
+	# kun results id
+	results() {
+	--
+	# voir la liste des personnes ayant répondu
+	# kun getpeople id
+	getpeople() {
+	--
+	# voir la réponse d'une personne à un sondage
+	# kun getanswer id nom_de_la_personne
+	getanswer() {
+
+et lancer la commande :
+
+	$ kun create
+	id du sondage pPfla
+
+Ou lancer kun sans arguments pour être guidé via un menu :
+
+	kun
+	>
+	> quitter
+	  créer un sondage
+	  répondre à un sondage
+	  consulter un sondage
+	  supprimer un sondage
+	  supprimer une réponse
diff --git a/commands.sh b/commands.sh
@@ -2,7 +2,7 @@
 # kun create
 create() {
 	id=$(mktemp -d /tmp/kun.XXXXX)
-	nano $id/question
+	$EDITOR $id/question
 	_success "id du sondage : ${id##/tmp/kun.}"
 }
 
diff --git a/kun.sh b/kun.sh
@@ -12,7 +12,7 @@ done
 
 [ "$help" = "yes" ] \
 	&& { echo "Les commandes dispos : \n"
-	     grep -E -B3 "^[a-zA-Z]+ *\(\) *{ *$" ./commands | grep -v ^$
+	     grep -E -B3 "^[a-zA-Z]+ *\(\) *{ *$" ./commands.sh | grep -v ^$
 		 exit 0;
 	   }