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

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

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

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

Автор

Дмитрий Бравиков

Инженер. Электронщик. Программист.

Добавить комментарий

Заполните поля или щелкните по значку, чтобы оставить свой комментарий:

Логотип WordPress.com

Для комментария используется ваша учётная запись WordPress.com. Выход /  Изменить )

Google photo

Для комментария используется ваша учётная запись Google. Выход /  Изменить )

Фотография Twitter

Для комментария используется ваша учётная запись Twitter. Выход /  Изменить )

Фотография Facebook

Для комментария используется ваша учётная запись Facebook. Выход /  Изменить )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.