Skip to content

RULES.md

Latest commit

 

History

History
36 lines (31 loc) · 1.37 KB

RULES.md

File metadata and controls

36 lines (31 loc) · 1.37 KB
Raw

Rules

Please follow this guide when naming Folders and Files in this repo.

Names

  • For the scope of these rules, names are either companys or products.
  • Names will follow same capatilisation as the origional.
  • Spaces in names will be replaced with a "_".
  • Hyphens (-), Numbers (123), will be preserved.
  • Special Symbols (~!@) should be removed if it causes complications with OS's file system.
  • Registered Trade Marks (®) will be removed from name.

File Names

  • Origional File Names from 3rd party sources can be preserved if they're easily understood.

Folder & File Names

docs/
 ├── Meshtastic_Devices/            
 │    └── <ManufactureName>_<DeviceName>_<VersonNumber> ##LILYGO_T-Beam_SUPREME_V3.0
 |          ├── README.md                               ##Device Info
 │          └── <Relevent Documents>
 |
 ├── Other_Devices/            
 │    └── <ManufactureName>_<DeviceName>_<VersonNumber> ##Waveshare_SIM7070G
 |          ├── README.md                               ##Device Info
 │          └── <Relevent Documents>
 │ 
 ├── Documents/            
 │    └── <ManufactureName>_<DeviceName>_<VersonNumber> ##Folder Template 
 |          └── README.md                               ##Device Info Template 
 │
 ├── RULES.md                  
 └── README.md