docs/naming.md

   1 Naming a module                         {#naming}
   2 ===============
   3
   4 UPM attemps to follow a clear naming pattern. Modules should be sensibly named
   5 and then placed in /usr/lib/upm and headers in /usr/include/upm.
   6
   7 ### Choosing a name
   8
   9 1. Pick a name
  10 2. Use it
  11
  12 ### Rules for name picking
  13
  14 1. Your lib must belong to namespace UPM
  15 2. Usually picking the name of the chip of your sensor/actuator might make
  16 sense. Other times this does not. Try to pick a generic name so people with a
  17 similar sensor can inherit your class if they only have minor changes.
  18 3. Avoid brand names
  19
  20 ### Doubt
  21
  22 If ever, give me a ping via email: brendan.le.foll@intel.com and I'll try
  23 suggest decent names for your module.
  24