Как вести проект в github для микроконтроллеров?

Question

[Mirn]

Начинаю осваивать GitHub.
До этого работал там где опенсурс недопустим да и мои хобби часто начинают приносить деньги - тогда я уже сам не хотел выкладывать. И поэтому особо с опенсурсом дел не имел, но надо меняться и прямо сейчас.

Создал первый пробный проект для микроконтроллера в Эклипсе с использованием GCC для STM32F407.
И немного развил его в гитхабе с небольшой кучкой коммитов.
вот он:
https://github.com/Mirn/Boot_F4_fast_uart
Для МК пишу на Си (gcc), для ПК ответную часть на Делфи (да, гнусная привычка из 90ых) которая общается с МК.

Возникли вопросы:
1. Как правильно для МК вести опенсурс разработки в гитхабе в целом? Есть ли особенности?
2. Нужно ли добавлять скрипты makefile и их вложения *.mk?
3. Интересует ли бинарник прошивки или его можно не прикладывать? А настройки проекта в Эклипсе?
4. Нужно ли прикладывать схемы и как если нужны?
5. Правильно ли веду я свой пробный проект? Всё ли понятно? Ну и хотелось бы немного критики по моему демо-проекту.
6. Какая этика и негласные правила в гитхабе существуют? я пытался нагуглить разные правила хорошего тона но их мало или противоречат сами себе. Какие самые верные и полезные?
7. Можно ли объединять проект для МК на Си и проект для ПК на остальных языках? В случае если они взаимносвязаны и друг без друга не могут как у меня реализация протокола работы на стороне ПК и на стороне МК.

Спасибо за внимание.

Answer 1

[aol-nnov]

• годные рецепты для гитигнора (в т.ч. по эклипсу)
  
• в репозитории должны быть исходники и правила сборки. результатов сборки быть не должно
  
• схемы и печатные платы в формате редактора (например, кикад)
  
• да, можно объединить проекты для мк и пк, но смысл? я бы не стал
  

в общем, начало положено, дальше напилинг и набивание опыта ;)

Comments

[Mirn]

"да, можно объединить проекты для мк и пк, но смысл? я бы не стал" - в случае если они взаимносвязаны - в моём примере это один единый протокол работы как МК так и на ПК, но в для ПК пришлось накидать обычное приложение с формочкой - логированием

[ТыжСисАдмин]

aol-nnov результат сборки можно приложить в архивчике как релиз :)

[Mirn]

"в репозитории должны быть исходники и правила сборки." мейкфайлы одновременно и промежуточные результаты сборки и правила сборки. Вот и интересно - пользуются ли люди голыми мейк-скриптами или достаточно только проекта Эклипса с правилами сборки в XML параметрах проекта?

[aol-nnov]

Алексей POS_troi: это уже не в репозитории будет

[aol-nnov]

Mirn: конечно, мейкфайлы позволяют собрать проект без установки ide. их надо обязательно включить.

[ТыжСисАдмин]

aol-nnov: я в общем, что если хочется бинарник прикрепить то для этого есть "релизы"

[aol-nnov]

Алексей POS_troi: случаи бывают разные, в том числе и клинические (зачеркнуто). :)
кому и lfs надо. но это точно не для результатов сборки.
да, про "релизы" согласен.

[ТыжСисАдмин]

aol-nnov: не, ну катологи с мусором от сборки должны быть не просто в gitignore а в глобальном gitignore, такая фигня не должна в репу попадать, хотя не редко вижу репу в которых служебные каталоги сред разработки валяются в репах с пачкуй файлов объёмом под сотню мегабайт :)

[Freeman]

Посмотрите исходники ОС "Фантом". Это хороший пример как не надо делать.

[Mirn]

Vapaamies: Что там не так? я нередко видел и более худший код или полное отсутсвие разделения на папки / проекты и цели сборки. Даже в популярных либах например

[aol-nnov]

Vapaamies: милейший, вы еще buildroot не видели, похоже ))
никакого криминала не вижу в пректе по ссылке

[Freeman]

Mirn: бинарники, бинарники, старье с бинарниками. Как раз то, о чем вы спрашивали. Попробуйте скачать, подивитесь размеру, а потом попробуйте понять, что из скачанного -- сам "Фантом".

[aol-nnov]

Vapaamies: всё понятно.я просто глубоко не полез смотреть, что это вообще за зверь %)

Answer 2

[Z-r]

> вести опенсурс разработки
> опенсурс

Пардон, что вы вкладываете в это странное сочетание звуков? То, что опубликовано на https://github.com/Mirn/Boot_F4_fast_uart сейчас, очевидно, несвободно (ну просто потому, что нигде не указно обратного). В смысле, вы намерены это все освободить?

> Created on: 05 èþëÿ 2016 ã.

Если уж оставляете комментарии на русском языке, то в CP1251 этого точно делать не стоит.

Comments

[Mirn]

спасибо, лицензия добавлена.

[Z-r]

Mirn, ну и славно. :-)

Answer 3

[Freeman]

А для Delphi никаких вопросов не возникает? Скажем, ddp-файлы нужны только тогда, когда в них и правда диаграммы. А хранение dsk-файлов в хранилище как минимум спорно. Большинство проектов обычно хранит pas, dfm и dpr.

Comments

[Mirn]

ооо, точно, не подумал, спасибо за инфу. Но интересует скорее для МК и для применений электроники на порядки больше вопросов.

Answer 4

[Александр Скуснов]

Мне нравятся примеры на Амперке по Ардуино (стиль), единственно - тёмный фон программы (становится голубым при выделении).