From 97ad716bd2b7c3970c1bc8cd713084314e4d5f00 Mon Sep 17 00:00:00 2001 From: tTh Date: Thu, 14 Nov 2024 10:11:11 +0100 Subject: [PATCH] little work on documentation --- Docs/README.md | 8 ++++---- Lib/README.md | 5 +++-- Tools/README.md | 21 ++++++++++++++++----- 3 files changed, 23 insertions(+), 11 deletions(-) diff --git a/Docs/README.md b/Docs/README.md index 6ebf403..2db31d9 100644 --- a/Docs/README.md +++ b/Docs/README.md @@ -1,4 +1,4 @@ -# libtthimage +# libtthimage, la doc Les fichiers [HTML](html/) que vous avez ici sont des versions historiques, qui seront peut-être mise à jour au prochain grand refactoring. @@ -13,11 +13,11 @@ Certaines options de compilation sont dans le fichier de [paramètres](../Paramakes.mk) pour les différents fichiers make. Je vous conseille de vérifier leurs pertinences, et en particulier les options `-p` et `-pg` que j'oublie parfois d'enlever avant -le _/push_. +le _push_. Le script [build.sh](../build.sh) tente d'automatiser les compilations de la bibilothèque, des tests et des outils -en ligne de commande. +en ligne de commande. Il est encore loin d'être parfait. ## Installation @@ -28,4 +28,4 @@ dans le fichier Paramakes.mk ! ## Utilisation -??? +??? *Insérez ici quelques exemples d'utilisation des tools.* diff --git a/Lib/README.md b/Lib/README.md index 1103c30..d9237d9 100644 --- a/Lib/README.md +++ b/Lib/README.md @@ -1,8 +1,9 @@ # The tTh image processing library Ugly software born around 1995 on a MS-Dos 286 computer. - -Look at the `Makefile` for no more explanations. +Look at the [`Makefile`](Makefile) for no more explanations. +More pertinent informations can be found in +[`tthimage.h`](../tthimage.h). ## Text primitives diff --git a/Tools/README.md b/Tools/README.md index 8f1ccd1..01ae3f2 100644 --- a/Tools/README.md +++ b/Tools/README.md @@ -50,9 +50,9 @@ La gestion de la ligne de commande est désastreuse. **À REFAIRE** ## tga_cadre -Pas mal de façons de mettre un cadre sur l'image. -Niveau de kitchitude assez élevé. -Paramètres mal documentés. +Il existe pas mal de façons de mettre un cadre sur l'image, +avec un niveau de kitchitude assez élevé. +Les paramètres sont mal documentés. ## tga_combine @@ -61,7 +61,8 @@ Usage: tga_combine s1.tga s2.tga MODE d.tga [PARAMS] ``` Il existe plein de façon de combiner deux images, la commande -`testtga list` vous les fera découvrir, la cinquième va vous étonner. +`tga_combine list` vous les fera découvrir, la cinquième va vous étonner. +Les paramètres sont mal documentés. ## tga_dither @@ -77,11 +78,16 @@ Attendu avec impatience, il aura le support complet des PNG. Un jour... ## tga_filtres +UTSL : [tga_filtres.c](caractère \textbf{invisible}) + ## tga_incrust ## tga_makehf15 -Pour les POViste acharnés. +Pour les POViste acharnés. De façon étrange, +[Povray](https://povray.org/) a choisi de stocker des +champs d'altitude dans les images Targa, en n'utilisant que +15 bits pour la valeur. ## tga_to_text @@ -102,6 +108,11 @@ vraiment trop nulle... ## tga_remap +Usage: `tga_remap M ` + +Le paramètre `M` peut prendre les valeurs 0, 1, 2, 11, 12 ou 13. +Je ne sais plus à quoi ça correspond. + ## tga_television ## tga_tools