readme для .c файлов

README.md

@@ -1,15 +1,46 @@
-# DebugVarEdit — Утилита для генерации переменных для отладки
+# DebugTools - Просмотр переменных через терминалку
+Модуль состоит из трех файлов:
+- **debug_tools.c** - реализация считывания переменных
+- **debug_tools.h** - объявление всякого для считывания переменных
+- **debug_vars.c** - определение массива считываемых переменных
 
+Этот модуль предоставляет функциональность для чтения значений переменных во встроенной системе, включая работу с IQ-форматами, защиту доступа и проверку диапазонов памяти.
+
+Для чтения переменных можно использовать функции:
+```c
+int Debug_ReadVar(int var_ind, long *return_long);
+int Debug_ReadVarName(int var_ind, DebugVarName_t name_ptr);
+```
+
+
+Переменные доступные для чтения определяются в **debug_vars.c** (их можно прописывать вручную или генерировать через **DebugVarEdit**):
+
+```c
+// Определение массива с указателями на переменные для отладки
+int DebugVar_Qnt = 5;
+#pragma DATA_SECTION(dbg_vars,".dbgvar_info")
+//																	pointer_type    iq_type			return_iq_type  short_name
+DebugVar_t dbg_vars[] = {\
+{(char *)&freqTerm,                                                 pt_float,       t_iq_none,      t_iq10,         "freqT"              }, \
+{(char *)&ADC_sf[0][0],                                             pt_int16,       t_iq_none,      t_iq_none,      "ADC_sf00"           }, \
+{(char *)&ADC_sf[0][1],                                             pt_int16,       t_iq_none,      t_iq_none,      "ADC_sf01"           }, \
+{(char *)&ADC_sf[0][2],                                             pt_int16,       t_iq_none,      t_iq_none,      "ADC_sf02"           }, \
+{(char *)&ADC_sf[0][3],                                             pt_int16,       t_iq_none,      t_iq_none,      "ADC_sf03"           }, \
+{(char *)&Bender[0].KOhms,                                          pt_uint16,      t_iq,      		t_iq10,      	"Bend0.KOhm"         }, \
+{(char *)&Bender[0].Times,                                          pt_uint16,      t_iq_none,      t_iq_none,      "Bend0.Time"         }, \
+};
+```
+
+# DebugVarEdit - Настройка переменных для терминалки
 **DebugVarEdit** — графическое приложение для Windows, предназначенное для настройки и генерации отладочных переменных (`debug_vars.c`) на основе исходного C-проекта. Работает с `makefile` проекта, сохраняет изменения в XML и позволяет удобно редактировать переменные и их типы через интерфейс.
 
 Программа — один исполняемый файл `DebugVarEdit.exe`, не требующий установки и дополнительных зависимостей.
 
 > Требуется Windows 7 или новее.
 
-> [Для разработчиков](#для-разработчиков)
 ---
 
-## Как использовать
+## Как использовать приложение
 
 1. Запустите **DebugVarEdit.exe.**
 
@@ -79,6 +110,7 @@
 </project>
 ```
 
+---
 ---
 
 # Для разработчиков