User Tools

Site Tools


en:rules

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
en:rules [2019/02/10 14:45] fluktuaciaen:rules [2022/03/08 21:58] – [Manual module creation] kaklik
Line 40: Line 40:
  
 ==== Manual module creation ==== ==== Manual module creation ====
-Iffor some reason, you are reluctant to use MLABgen for creation of the basic directory structure, it is necessary to comply with the following rules:  +If for some reason, you are reluctant to use MLABgen for the creation of the basic directory structure, it is necessary to comply with the following rules: 
- +
-In the appropriate folder category we create a folder with the name of the new module using a format ''NAMEVERREV’’. +
-Inside the folder, we create the following directory structure (obligatory folders/files are marked with an asterisk):+
  
 +In the appropriate folder category, we create a folder with the name of the new module using the format ''NAMEVERREV’’ . Inside the folder, we create the following directory structure (obligatory folders/files are marked with an asterisk):
  
 +''
   <NAMEVERREV>*   <NAMEVERREV>*
   ├── doc*   ├── doc*
Line 74: Line 73:
   ├── <NAMEVERREV>.json*   ├── <NAMEVERREV>.json*
   └── sw   └── sw
-      └── <NAMEVERREV>_exmalpe.py+      └── <NAMEVERREV>_exmalpe.py''
  
 The file ''<NAMEVERREV.json>'' should contain the information concerning the module. The file ''<NAMEVERREV.json>'' should contain the information concerning the module.
Line 96: Line 95:
   }   }
  
-You can find example of a correct filling by checking one of the already existing [[https://github.com/MLAB-project/Modules/blob/master/sensors/ALTIMET01A/ALTIMET01A.json|module]].+You can find an example of a correct filling by checking one of the already existing [[https://github.com/MLAB-project/Modules/blob/master/sensors/ALTIMET01A/ALTIMET01A.json|module]].
  
 ===== Module power supply ===== ===== Module power supply =====
Line 319: Line 318:
 === KiCAD === === KiCAD ===
  
 +QRcode pictures can be  [[http://www.re-innovation.co.uk/web12/index.php/en/blog-75/230-adding-logo-to-kicad|added]] to KiCAD in the same way as logo.
  
-Obrázky QRkódů se do KiCAD  [[http://www.re-innovation.co.uk/web12/index.php/en/blog-75/230-adding-logo-to-kicad|převedou]] stejně jako logo.  +===== Check list before production =====
- +
-===== Check list před výrobou =====+
  
-  - zkontrolovat velikost spravnost pouzder +  - check if the encasements are right and of good size  
-  - Velikost plosek u konektoru a soucastek skrz desku.  +  - check the size of connector’s spaces (??ploška) and sizes of components that go through the board  
-  - velikost derkrystaly ledkyhrebinkypropojky, specialni soucastky. +  - check the sizes of holesLED crystalspins (hřebík??)jumpers (?? Propojka) or other special components  
-  - odmaskovani plošek, propojky +  - check the unmasking of (??) plošek and jumpers (??)  
-  - obrysy soucastek, oznaceni propojek. +  - check the components’ outlines and labelling of jumpers (??) 
-  - popiskynapis www.mlab.cz +  - check the labels and legends, www.mlab.cz title 
-  - Zkontrolovat, ze nejsou prokovy pod pismeny a znaky +  - check that the VIAs are not under letters and symbols 
-  - zkontrolovat QR kod a PermaLink.+  - check the QR code and PermaLink
  
  
-===== Struktura repozitáře MLABu =====+===== MLAB repository structure=====
  
  
-  * Projektová metadata - json +  * Project metadata - json 
-  * Commit message - začátek velké písmeno, slova jako added, fixed, removed, started, finished... +  * Commit message - begins with capital latter; uses words such as: added, fixed, removed, started, finished... 
  
-==== Jmenná konvence ====+==== Name convention ====
  
-bez_diakritiky_a_specialnich_znaku_mezery_nahrazeny_podtrzitkem_pouze_mala_pismena_strucne_a_srozumitelne+withouth_diacritic_and_special_cases_spaces_are_replaced_by_an_underscore_lowercase_letters_only_briefly_and_comprehensibly
  
  
  
-==== Adersářová struktura modulu ====+====  Modules’ directory structure ====
  
   MODUL01A/   MODUL01A/
en/rules.txt · Last modified: 2023/02/03 00:14 by kaklik