Документация на программы для микроконтроллеров

Всегда пишите документацию на программы для микроконтроллеров. Добавьте в каталог проекта файл README.

Содержимое README:

  • тип микроконтроллера,
  • устройство в которое этот микроконтроллер встраивается,
  • среда проектирования (название, версия, настройки),
  • библиотеки (название, версия, ссылка на скачивание),
  • пути поиска подключаемых файлов,
  • список подключаемых файлов *.c,
  • тактовые частоты,
  • распределение ресурсов (например: светодиод: порт PB3, таймер TIM1),
  • изменения.