mlab-modules / modul01

Template repository

MODUL01 - Template to create a new MLAB module

MLAB's module template repository. Please use the "Use this template" button 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 for an acceptable naming convention. After creating the new repository, rename 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 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

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.

3. Copy the fresh automation workflows

The following command copies up-to-date KiCAD automation workflow to the new MLAB module repository.

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!

modul01's Issues

Unused directories in projects

The universal structure of the template repository does not fit for every project. For example, there could be a minimum number of projects which use the HDL folder for FPGA sources.

A better approach is currently unknown.

Default branch MODUL01A needs to be renamed

In the process where GitHub creates a new repository from the Template repository, the branching structure is also copied. The result is a need for renaming of the original branch to the new module name.

The possible improvement of that situation could be a script which rename the branch according to the new repository name an then deletes itself from the new repository.