Работа над документами

ccpp/template/.gitignore

@@ -0,0 +1,2 @@
+build
+sandbox

ccpp/template/CMakeLists.txt

@@ -0,0 +1,7 @@
+cmake_minimum_required(VERSION 3.10)
+project(neurox)
+set(HEADERS headers/_header.h)
+set(INCLUDES includes/include.h)
+set(SOURCES src/source.c)
+add_library(template SHARED ${INCLUDES} ${HEADERS} ${SOURCES})
+target_include_directories(neurox PUBLIC includes PRIVATE headers)

ccpp/template/DAIRY.md

@@ -0,0 +1 @@
+# DAIRY.md

ccpp/template/PROGRESS.md

@@ -0,0 +1,30 @@
+# PROGRESS.md
+
+## Формат
+* Даты следуют в обратном хронологическом порядке
+* Формат таблиц: Статус → Задача → Краткое описание
+
+## Условные обозначения
+* ➤ — задача выполняется
+* ✔️ — задача выполнена полностью
+* ⚠️ — задача отложена
+* ☐ — задача ожидает выполнения
+
+Структура таблиц
+
+| Статус | Задача | Описание |
+|:------:|:-------|:---------|
+
+
+## Общий прогресс
+| Статус | Задача | Описание |
+|:------:|:-------|:---------|
+| ☐ |Препрофилирование|Расчёт предполагаемых нагрузок малые/средние/максимальные|
+| ☐ |Проектирование архитектуры|Определение узких мест, API, внутреннего устройства|
+| ☐ |Logic|Реализация внутренней логики модуля|
+| ☐ |API|Реализация внешнего интерфейса|
+| ☐ |Предварительное тестирование|Юнит-тесты, бенчмарки|
+| ☐ |Нагрузочные тесты|Анализ работы при максимальных нагрузках|
+| ☐ |Интеграция|Тестирование взаимодействия с другими модулями|
+| ☐ |Документирование|Подготовка технической документации модуля|
+| ☐ |Итоги|Финальная проверка, анализ работы, фидбэк(если предусмотрен)|

ccpp/template/README.md

@@ -0,0 +1 @@
+# README.md

ccpp/template/TODO.md

@@ -0,0 +1,15 @@
+# TODO.md
+
+## Информация
+* Файл для отслеживания текущих задач модуля **Module**
+* Последнее обновление: [дд.мм.гггг]
+
+## Условные обозначения
+* 🔥 - Наивысший приоритет
+* 🔴 - Высокий приоритет
+* 🟡 - Средний приоритет
+* 🟢 - Низкий приоритет
+
+## Задачи в процессе
+|Срочность|Компонент|Задача|Описание|
+|:-------:|:-------:|:-----|:-------|

ccpp/template/headers/_header.h

@@ -0,0 +1,17 @@
+#pragma once
+
+/**
+ * @author admin@felexdev.ru
+ * @version 1.0.0
+ * 
+ * @brief Header template
+ */
+ 
+#ifdef __cplusplus
+extern "C" {
+#endif //__cplusplus
+
+
+#ifdef __cplusplus
+}
+#endif //__cplusplus

ccpp/template/includes/include.h

@@ -0,0 +1,17 @@
+#pragma once
+
+/**
+ * @author admin@felexdev.ru
+ * @version 1.0.0
+ * 
+ * @brief Include emplate
+ * */
+
+#ifdef __cplusplus
+extern "C" {
+#endif //__cplusplus
+
+
+#ifdef __cplusplus
+}
+#endif //__cplusplus

ccpp/template/src/source.c

@@ -0,0 +1,10 @@
+/**
+ * @author admin@felexdev.ru
+ * @version 1.0.0
+ * 
+ * @brief Sourcecode template
+ */
+
+int example() {
+    return 0;
+}