From 13e08c0eb131eefdd49ed024619c2a79a6040014 Mon Sep 17 00:00:00 2001
From: Ferenc Szontágh <szf@fsociety.hu>
Date: Sat, 03 Feb 2024 21:34:58 +0000
Subject: [PATCH] somre docs about the signals and tokens

---
 README.md |   17 ++++++++++++++++-
 1 files changed, 16 insertions(+), 1 deletions(-)

diff --git a/README.md b/README.md
index 79b8006..9ceb27f 100644
--- a/README.md
+++ b/README.md
@@ -44,4 +44,19 @@
 See @git.spamming.hu ticketing system
 
 ### - IDE
-Use the vscode... Install the extensions which is recommended by the workspace
\ No newline at end of file
+Use the vscode... Install the extensions which is recommended by the workspace
+
+## Table Of Thread signal tokens (W.I.P)
+
+| thread tokens       | payload       | string | desc                                                                              | comment                                                                                               |
+| ------------------- | ------------- | ------ | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
+| MODEL_LOAD_START    | QM::QueueItem |        | model load started                                                                | only occurs, when no model loaded, or the job have another model                                      |
+| MODEL_LOAD_DONE     | sd_ctx\*      |        | model is loaded                                                                   | the model is loaded and the pointer returning as payload. The pointer will be reused in the next etap |
+| MODEL_LOAD_ERROR    | QM::QueueItem |        | model is not loaded, something went wrong at the backend                          |
+| GENERATION_ERROR    | QM::QueueItem |        |                                                                                   |                                                                                                       |
+| QUEUE               | QM::QueueItem |        | simple queue msgs, the string is always a number                                  |
+| GENERATION_START    | QM::QueueItem |        | the generation just started                                                       |
+| GENERATION_PROGRESS |               |        | for progressbar, if sometimes the sd.cpp implements some progress handling        | not used, while no progress info from the backend                                                     |
+| GENERATION_DONE     | sd_image_t \* |        | everything is done, images saved to the output. Payload is the sd_image_t pointer |
+
+table generated with https://tabletomarkdown.com/convert-spreadsheet-to-markdown/
\ No newline at end of file

--
Gitblit v1.9.3