Initial commit

Author: kaklik

.github/workflows/metadata_updater.yml

@@ -0,0 +1,45 @@
+name: Metadata updater
+
+on:
+  push:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f doc/assets/workflows/requirements.txt ]; then pip install -r doc/assets/workflows/requirements.txt; fi
+
+    - name: Update metadata
+      env:
+        gh_repo: ${{ github.event.repository.name }}
+        gh_url: ${{ github.server_url }}/${{ github.repository }}
+        gh_branch: ${{ github.head_ref || github.ref_name }}
+        gh_description: ${{ github.event.repository.name }}
+        gh_repository: ${{ github.repository }}
+        gh_token: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        python3 doc/assets/workflows/update_metadata.py
+        python3 doc/assets/workflows/update_kitspace.py
+
+    - uses: stefanzweifel/git-auto-commit-action@v4.16.0
+      with:
+        commit_message: Update metadata files
+        commit_options: '-a'

.github/workflows/update_actions.yml

@@ -0,0 +1,41 @@
+name: Update actions and assets repository
+on:
+  schedule:
+  - cron: "0 */24 * * *"
+  
+  push:
+    paths:
+      - '.gitmodules'
+
+  workflow_dispatch:
+  
+jobs:
+  Aktualizace:
+     name: Update repository actions and other tools
+     runs-on: ubuntu-latest
+     steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+          token: ${{ secrets.pat }}
+          ref: ${{ github.head_ref }}
+          
+      - name: Update submodules
+        run: |
+          git -C doc/assets config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
+          git submodule sync doc/assets
+          git submodule update --init --remote doc/assets
+          
+      - name: Update submodules
+        run: |
+          git submodule update --remote doc/assets/
+    
+      - name: Zaktualizovat skripty
+        run: |
+          cd doc/assets/workflows/ && ./copy_workflow_to_repo.sh && cd ${GITHUB_WORKSPACE}
+          
+      - uses: stefanzweifel/git-auto-commit-action@v4.16.0
+        with:
+          commit_message: Update workflow files
+          add_options: '-A'
+          commit_options: '-a'

.gitignore

@@ -0,0 +1,247 @@
+doc/gen/*
+hw/cam_profi/*
+*-backups
+
+# For PCBs designed using KiCad: http://www.kicad-pcb.org/
+
+# Temporary files
+*.000
+*.bak
+*.bck
+*.kicad_pcb-bak
+*~
+*_autosave-*
+*.tmp
+*-backups
+
+# Netlist files (exported from Eeschema)
+#*.net
+
+# Autorouter files (exported from Pcbnew)
+.dsn
+
+# Exported BOM files
+#*.xml
+#*.csv
+
+## Core latex/pdflatex auxiliary files:
+*.aux
+*.lof
+*.log
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+
+## Intermediate documents:
+*.dvi
+*-converted-to.*
+# these rules might exclude image files for figures etc.
+# *.ps
+# *.eps
+# *.pdf
+
+## Generated if empty string is given at "Please type another file name for output:"
+.pdf
+
+## Bibliography auxiliary files (bibtex/biblatex/biber):
+*.bbl
+*.bcf
+*.blg
+*-blx.aux
+*-blx.bib
+*.brf
+*.run.xml
+
+## Build tool auxiliary files:
+*.fdb_latexmk
+*.synctex
+*.synctex(busy)
+*.synctex.gz
+*.synctex.gz(busy)
+*.pdfsync
+
+## Auxiliary and intermediate files from other packages:
+# algorithms
+*.alg
+*.loa
+
+# achemso
+acs-*.bib
+
+# amsthm
+*.thm
+
+# beamer
+*.nav
+*.pre
+*.snm
+*.vrb
+
+# changes
+*.soc
+
+# cprotect
+*.cpt
+
+# elsarticle (documentclass of Elsevier journals)
+*.spl
+
+# endnotes
+*.ent
+
+# fixme
+*.lox
+
+# feynmf/feynmp
+*.mf
+*.mp
+*.t[1-9]
+*.t[1-9][0-9]
+*.tfm
+*.[1-9]
+*.[1-9][0-9]
+
+#(r)(e)ledmac/(r)(e)ledpar
+*.end
+*.?end
+*.[1-9]
+*.[1-9][0-9]
+*.[1-9][0-9][0-9]
+*.[1-9]R
+*.[1-9][0-9]R
+*.[1-9][0-9][0-9]R
+*.eledsec[1-9]
+*.eledsec[1-9]R
+*.eledsec[1-9][0-9]
+*.eledsec[1-9][0-9]R
+*.eledsec[1-9][0-9][0-9]
+*.eledsec[1-9][0-9][0-9]R
+
+# glossaries
+*.acn
+*.acr
+*.glg
+*.glo
+*.gls
+*.glsdefs
+
+# gnuplottex
+*-gnuplottex-*
+
+# gregoriotex
+*.gaux
+*.gtex
+
+# hyperref
+*.brf
+
+# knitr
+*-concordance.tex
+# TODO Comment the next line if you want to keep your tikz graphics files
+*.tikz
+*-tikzDictionary
+
+# listings
+*.lol
+
+# makeidx
+*.idx
+*.ilg
+*.ind
+*.ist
+
+# minitoc
+*.maf
+*.mlf
+*.mlt
+*.mtc[0-9]*
+
+# minted
+_minted*
+*.pyg
+
+# morewrites
+*.mw
+
+# mylatexformat
+*.fmt
+
+# nomencl
+*.nlo
+
+# pax
+*.pax
+
+# sagetex
+*.sagetex.sage
+*.sagetex.py
+*.sagetex.scmd
+
+# scrwfile
+*.wrt
+
+# sympy
+*.sout
+*.sympy
+sympy-plots-for-*.tex/
+
+# pdfcomment
+*.upa
+*.upb
+
+# pythontex
+*.pytxcode
+pythontex-files-*/
+
+# thmtools
+*.loe
+
+# TikZ & PGF
+*.dpth
+*.md5
+*.auxlock
+
+# todonotes
+*.tdo
+
+# easy-todo
+*.lod
+
+# xindy
+*.xdy
+
+# xypic precompiled matrices
+*.xyc
+
+# endfloat
+*.ttt
+*.fff
+
+# Latexian
+TSWLatexianTemp*
+
+## Editors:
+# WinEdt
+*.bak
+*.sav
+
+# Texpad
+.texpadtmp
+
+# Kile
+*.backup
+
+# KBibTeX
+*~[0-9]*
+
+# auto folder when using emacs and auctex 
+/auto/*
+
+# expex forward references with \gathertags
+*-tags.tex
+

.gitmodules

@@ -0,0 +1,5 @@
+[submodule "doc/assets"]
+	path = doc/assets
+	url = git@github.com:MLAB-project/documents.git
+	branch = KiCADv6
+        shallow = 1

LICENSE

@@ -0,0 +1,36 @@
+# MODUL01 - Template to create a new MLAB module
+
+MLAB's module template repository. Please [use the "Use this template" button](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template) to create a new MLAB module from this repository.
+
+The new module repository name must be identical to the proposed new module name. Please look in [MLAB design rules](https://wiki.mlab.cz/doku.php?id=en:rules#identification_of_modules) for an acceptable naming convention.
+After creating the new repository, [rename](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch) the default git branch to be named corresponding to the revision of the module. It is generally adding the "A" suffix to the module name. Therefore, a new repository named MODULENAME01 should have the branch name MODULENAME01A. 
+
+Then [clone the new MLAB's module repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to your workstation. After that perform the following steps in the cloned repository. 
+
+## 1. Initialize the assets submodule, and update it to the latest version
+```bash
+git submodule update --init --remote
+```
+
+## 2. Start the design work 
+
+At that point, you should start to design the new MLAB module project by using the [design tools](https://wiki.mlab.cz/doku.php?id=en:tools).
+
+## 3. Copy the fresh automation workflows
+    
+The following command copies up-to-date KiCAD automation workflow to the new MLAB module repository.
+```bash
+cd doc/assets/workflows/
+./copy_workflow_to_repo.sh
+```
+
+
+## 4. Replace this readme
+
+This readme should be replaced by a description of your new module project! :)
+Please look to the README.md in the root of other modules to get inspiration. 
+
+Thanks for contributing! 
+
+
+    

README.md

@@ -0,0 +1,14 @@
+description: Template repository
+github_branch: MODUL01A
+github_branches:
+- MODUL01A
+github_repo: MODUL01
+github_url: https://github.com/mlab-modules/MODUL01
+homepage: false
+images: []
+issues: 2
+mark: 50
+tags:
+- mlab
+- mlab-module
+title: MODUL01

doc/assets

@@ -0,0 +1,8 @@
+bom: hw/sch_pcb/MODUL01.kicad_pcb
+color: white
+eda:
+  pcb: hw/sch_pcb/MODUL01.kicad_pcb
+  type: kicad
+gerbers: hw/cam_profi/
+site: https://github.com/mlab-modules/MODUL01
+summary: Template repository