From 74efca432d6b4282434372e02b0db70c60180f34 Mon Sep 17 00:00:00 2001
From: Alexander Popov <iiiypuk@fastmail.fm>
Date: Sun, 10 Sep 2023 01:02:36 +0300
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?=
 =?UTF-8?q?=D0=BD=20READ.ME=20=D0=B4=D0=BB=D1=8F=20Arduino?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 snipplets/code/Arduino/README.md                     | 12 ++++++++++++
 snipplets/code/Arduino/compile_date_time.c           |  6 +++++-
 snipplets/code/Arduino/convert_DATE_to_YYYY-MM-DD.c  |  3 +++
 snipplets/code/Arduino/init_blink.h                  |  2 ++
 snipplets/code/Arduino/serial.ino                    |  3 +++
 .../{variable_sizes.ino => variables_sizes.ino}      |  4 ++++
 6 files changed, 29 insertions(+), 1 deletion(-)
 rename snipplets/code/Arduino/{variable_sizes.ino => variables_sizes.ino} (91%)

diff --git a/snipplets/code/Arduino/README.md b/snipplets/code/Arduino/README.md
index 7dfd105..fd26190 100644
--- a/snipplets/code/Arduino/README.md
+++ b/snipplets/code/Arduino/README.md
@@ -1,3 +1,15 @@
+# Arduino
+
+## std
+
+* [Пример, который возвращает дату и время компиляции скетча](compile_date_time.c)
+* [Размер типов перенных в байтах](variables_sizes.ino)
+* Пример работы с [EEPROM](eeprom.ino)
+
+## Функции
+
+* Функция, которая моргает встроенным светодиодом [`void init_blink(int times, int delay)`](init_blink.h)
+
 ## Память
 
 | Тип    | Чтение из программы | Запись из программы | Очистка при перезагрузке |
diff --git a/snipplets/code/Arduino/compile_date_time.c b/snipplets/code/Arduino/compile_date_time.c
index 21df4a5..861756e 100644
--- a/snipplets/code/Arduino/compile_date_time.c
+++ b/snipplets/code/Arduino/compile_date_time.c
@@ -1,7 +1,11 @@
+/**
+ * Пример, который возвращает дату и время компиляции скетча
+ */
+
 void loop() {
     Serial.println("Built: " __DATE__ " | " __TIME__);
     /**
-     * Example show:
+     * Output:
      * Built: Aug 16 2023 | 21:42:32
      */
 }
diff --git a/snipplets/code/Arduino/convert_DATE_to_YYYY-MM-DD.c b/snipplets/code/Arduino/convert_DATE_to_YYYY-MM-DD.c
index 22eeec7..720d32c 100644
--- a/snipplets/code/Arduino/convert_DATE_to_YYYY-MM-DD.c
+++ b/snipplets/code/Arduino/convert_DATE_to_YYYY-MM-DD.c
@@ -1,3 +1,6 @@
+// TODO: Добавить описание
+// TODO: Добавить в README.md
+
 // Adapted from http://stackoverflow.com/questions/1765014/convert-string-from-date-into-a-time-t
 // Formats __DATE__ to YYYY-MM-DD format
 String ArduinoDateToDisplayDate(char const *time) {
diff --git a/snipplets/code/Arduino/init_blink.h b/snipplets/code/Arduino/init_blink.h
index a85404f..572b562 100644
--- a/snipplets/code/Arduino/init_blink.h
+++ b/snipplets/code/Arduino/init_blink.h
@@ -1,6 +1,8 @@
 /*
     Author: Alexander Popov
     License: Unlicense
+
+    Функция, которая моргает встроенным светодиодом
 */
 
 void init_blink(int times, int delay) {
diff --git a/snipplets/code/Arduino/serial.ino b/snipplets/code/Arduino/serial.ino
index d934080..4668395 100644
--- a/snipplets/code/Arduino/serial.ino
+++ b/snipplets/code/Arduino/serial.ino
@@ -1,3 +1,6 @@
+// TODO: Доработать пример
+// TODO: Добавить в README.md
+
 // будем искать слово hello
 char target[] = "hello";
 
diff --git a/snipplets/code/Arduino/variable_sizes.ino b/snipplets/code/Arduino/variables_sizes.ino
similarity index 91%
rename from snipplets/code/Arduino/variable_sizes.ino
rename to snipplets/code/Arduino/variables_sizes.ino
index ad586e8..355eb6e 100644
--- a/snipplets/code/Arduino/variable_sizes.ino
+++ b/snipplets/code/Arduino/variables_sizes.ino
@@ -1,3 +1,7 @@
+/**
+ * Скетч, который выводит в Serial размер типов переменных в байтах
+ */
+
 void setup() {
   Serial.begin(9600);