From 796a0d07593308a4b15e1504e8af3bd41ba71743 Mon Sep 17 00:00:00 2001 From: nikita Date: Sat, 10 Jan 2026 19:19:00 +0300 Subject: [PATCH] Add README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fd4d698 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Именование репозиториев + +## Таблица платформ + +|Код|Расшифровка| +|--|--| +|`all`|Все платформы| +|`pc`|Приложение для Windows, Linux или другой полноценной операционной системы| +|`rpi`|Приложение для Linux, предназначенное для запуска исключительно на Raspberry Pi| +|`win`|Приложение только для Windows| +|`linux`|Приложение только для Linux| +|`arduino`|Приложение для классической Arduino, построенной на базе чипов Atmel| +|`esp8266`|Приложение для чипа ESP8266 (в т.ч. с использованием Arduino IDE)| +|`esp32`|Приложение для чипа ESP32 (в т.ч. с использованием Arduino IDE)| +|`atmegaXXXX`|Приложение для чипа Atmega (обязательно указывать полное имя чипа)| +|`attinyXXXX`|Приложение для чипа Attiny (обязательно указывать полное имя чипа)| +|`rpizero`|Приложение для Raspberry Pi Zero| + +## Самостоятельные проекты + +Репозитории именуются по формуле **`year`-`platform`-`name`**, где: +* `year` - год создания проекта (именно проекта - не репозитория) +* `platform` - платформа (см. таблицу в начале) +* `name` - имя проекта (маленькими буквами, слова разделяются минусами) + +Например: +* `2025-pc-triple-weight` +* `2023-esp8266-cyberhouse-space-station-rx` +* `2023-arduino-funky-clock` +* `2023-win-prp-client` + +## Библиотеки + +Репозитории именуются по формуле **lib-`lang`-`name`**, где: +* `lang` - язык программирования (`c`, `cpp`, `cs`, `py`) +* `name` - название библиотеки (маленькими буквами, слова разделяются минусами) + +Например: +* `lib-py-osc` +* `lib-c-bmp-stream` +* `lib-c-prp` \ No newline at end of file