Differences

This shows you the differences between two versions of the page.

--- en:rules [2022/03/08 22:00] – [Externí napájecí zdroje] kaklik
+++ en:rules [2023/01/13 12:10] – Adding note how to create module from the template repository. 94.112.192.193
@@ Line 1: / Line 1: @@
-FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)//
+FIXME **This page is not fully translated, yet. Please help complete the translation.**\\ //(remove this paragraph once the translation is finished)//
 ====== Rules for designing new modules ======
-This page serves as a wiki complement to an original article [[http://www.mlab.cz/Articles/HowTo/Rules/DOC/HTML/Rules.cs.html|Proposed rules and standard procedures]]. It also serves as a site for placing additional rules of module design, which are not dealt with in the article.
+This page serves as a wiki complement to an original article [[http://home.mlab.cz/Articles/HowTo/Rules/DOC/HTML/Rules.cs.html|Proposed rules and standard procedures]]. It also serves as a site for placing additional rules of module design, which are not dealt with in the article.
-The module design itself uses a following [[en:tools|software tools]].
+The module design itself uses the following [[en:tools|software tools]].
 ===== Identification of modules =====
-Each modules has to carry a unambiguous identification mark consisting of its name, version and module revision - e.g. [[cs:jtagft2232v|JTAGFT2232V02A]].
+Each module has to carry an unambiguous identification mark consisting of its name, version, and module revision - e.g. [[cs:jtagft2232v|JTAGFT2232V02A]].
   - JTAGFT2232 -  the name of the module, depicting the nature of the module (here probably a J-tag programmer with FTDI FT2232 chip).
@@ Line 15: / Line 15: @@
   - A - the module’s revision (in this case there were not corrections of any mistakes)
-Furthermore there are modules with green non-soldering mask and white print and modules with white mask and green print. This kind of module identification was introduced by [[http://www.ust.cz/|UST]] company, which produces modules for MLAB. The meaning of the above-mentioned colour identification is as follows:
+Furthermore, there are modules with green non-soldering mask and white print and modules with white mask and green print. This kind of module identification was introduced by [[http://www.ust.cz/|UST]] company, which produces modules for MLAB. The meaning of the above-mentioned colour identification is as follows:
   * **Green mask and white print** - a prototype module, often made only in one or few pieces serving as testing samples
-  * **White mask and black print** - a production version made in large quantities. Compared to the green version, it may contain tiny changes changes even if the module’s identification mark is identical.
+  * **White mask and black print** - a production version made in large quantities. Compared to the green version, it may contain tiny changes even if the module’s identification mark is identical.
 ===== Creating a new module =====
+==== Using a GitHub template ====
+The probably simplest way how to make a new module structure is to create a new repository based on the [[https://github.com/mlab-modules/MODUL01 | GitHub MLAB module template repository]].
+The template repository should be used in [[https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template | the standard GitHub way]].
 ==== Using a mlabgen script ====