From 6069c45b5a22e188f0386d2704c1c260023f1791 Mon Sep 17 00:00:00 2001 From: tTh Date: Wed, 28 Aug 2024 21:23:09 +0200 Subject: [PATCH] working on readme files --- README.md | 30 +++++++++++++++++++++++------- experiment/README.md | 4 ++-- funcs/README.md | 5 +++-- lib/README.md | 3 ++- 4 files changed, 30 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ccd1db3..cf5149a 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ voire même des [films flous](Fonderie/). ![horloge floue](http://la.buvette.org/photos/cumul/horloge.png "horloge floue") - Il y a une [description](http://la.buvette.org/photos/cumul/) bien plus pas trop longue pour les curieux, et un début de [documentation](http://la.buvette.org/photos/cumul/the_floatimg_hack.pdf) @@ -22,7 +21,20 @@ Par ailleurs, d'autres expérimentations sont sur le traitement et l'assemblage de ces images floues dans le but de faire des films flous. -*En avant vers l'infini, et au-delà...* +## *Show us the code !* + +Il y a plusieurs répertoires contenant le code source, en voici +la liste : + + * [lib](lib/README.md) : le noyau du système, fonctions de base. + * [funcs](funcs/README.md) : fonctions de support : export, traitement + filtrage, effets... + * [tools](tools/README.md) : utilitaires divers, outils de debug et gadgets. + * [v4l2](v4l2/README.md): gestion des webcams sous Linux. + * [experiment](experiment/README.md) : fonctions en chantier, qui migreront + un jour dans d'autres catégories. + * [contrib](contrib/README.md) : des choses peu ou pas maintenues. + ## Dépendances @@ -38,7 +50,6 @@ apt install libv4l2-dev apt install libcfitsio-dev apt install libnetpbm-dev ``` - Bon, OK, je suis en train de changer de machine, et ça serait vraiment cool d'avoir juste une ligne à c'n'p, donc voila : @@ -46,7 +57,6 @@ cool d'avoir juste une ligne à c'n'p, donc voila : apt install libtiff-dev libpnglite-dev liblo-dev libv4l2-dev \ libcfitsio-dev libnetpbm-dev ``` - Il est probable que j'en oublie. Et ya Debian qui change des trucs, alors, ça marche plus, du genre que c'est la deuxième fois que ça m'arrive. @@ -63,9 +73,9 @@ coté de pkg-config. Certains outils externes sont aussi utiles : -- gnuplot -- ImageMagick -- LaTeX +- gnuplot, pour analyser des données, +- ImageMagick, parce que Brunus aime ça, +- LaTeX, pour la (trop maigre) documentation. ## Documentation @@ -73,4 +83,10 @@ Encore trop légère, mais déja [présente](doc/). C'est à vous de compiler le [PDF](http://la.buvette.org/photos/cumul/the_floatimg_hack.pdf) +## TODO + +https://berthub.eu/articles/posts/always-do-this-floating-point/ + +## Conclusion + *Your mileage may vary...* diff --git a/experiment/README.md b/experiment/README.md index 73dfdaa..67ee33f 100644 --- a/experiment/README.md +++ b/experiment/README.md @@ -1,7 +1,7 @@ -# EXPÉRIMENTATIONS ÀLC +# Expérimentations ÀLC Attention, tout ce qui se trouve dans ce répertoire ne sont que des -essais. Certains aboutissent, et sont migrés vers `funcs/` ou +essais. Certains aboutissent, et sont migrés vers `lib/`, `funcs/` ou `tools/`, d'autre échouent et restent trainer dans le coin en attente du retour de l'inspiration. diff --git a/funcs/README.md b/funcs/README.md index 0c9b3eb..6a2d27e 100644 --- a/funcs/README.md +++ b/funcs/README.md @@ -21,9 +21,10 @@ Et en particulier, elle brotche sur ceux produits par ImageMagick ! ### FITS -Ce format de fichier est utilisé en astronomie. +Ce [format de fichier](https://heasarc.gsfc.nasa.gov/docs/software/fitsio/c/c_user/node1.html) +est utilisé en astronomie. +Son support est actuellement minimaliste. -https://heasarc.gsfc.nasa.gov/docs/software/fitsio/c/c_user/node1.html ### DICOM diff --git a/lib/README.md b/lib/README.md index 6f113ee..22e7c52 100644 --- a/lib/README.md +++ b/lib/README.md @@ -21,5 +21,6 @@ typedef struct { int reserved; } FloatImg; ``` - +For the current state of this struc, look at the main +[header file](../floatimg.h), located at the root of the project.