Add readme for cards and hardware dir placeholder

SciProgCentre · Sep 2, 2023 · 53a3069 · 53a3069
1 parent d30e076
commit 53a3069
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/source/cards/README.md b/source/cards/README.md
@@ -0,0 +1,10 @@
+# Карточки с учебными материалами
+
+В этой директории размещаются карточки с учебными материалами. 
+Для составления карточки руководствуемся следующими правилами:
+* Каждая карточка представляет markdown файл, с материалом на определённую тему. 
+* Карточка может включать `rst` директивы.
+* Карточка может иметь зависимые файлы: картинки, блокноты Jupyter Notebook, диаграммы и файлы с исходным кодом.
+* Карточка должна иметь заголовок первого уровня, отображающий тему карточки.
+* Карточка может иметь заголовки второго уровня, при компиляции в `reveal.js`-презентацию, они превращаются в вертикальные подслайды.
+* Карточка не должна превращать в копию документации, лучше дать ссылку на документацию, а на карточке разобрать неочевидные моменты или те на которых надо заострить внимание.
diff --git a/source/cards/hardware/.placeholder b/source/cards/hardware/.placeholder