util/coreboot-configurator/src/README.md

   1 # Categories ![alt text](images/StarLabs_Logo.png "Star Labs Systems")
   2
   3 CMOS values should be added to [categories.yaml](src/application/categories.yaml].
   4
   5 This allows `coreboot-configurator` to display them in a relavant tab, with a nice
   6 name and help text. Without this, they will still be visible in the **Raw** tab.
   7
   8 An example entry is below:
   9 ```
  10 processor:
  11   displayName: Processor
  12   me_state:
  13     displayName: Intel Management Engine
  14     type: bool
  15     help: Enable or disable the Intel Management Engine
  16 ```
  17
  18 To explain the options:
  19 ```
  20 **tabgroup**:                           <- This is the reference to the tab group
  21   displayName: **Hello World**          <- This is the name of the group that the user
  22                                            will see
  23   **setting_1**:                        <- This is the value that should match the CMOS
  24                                            option.
  25     displayName: **Hi World**           <- This is the name of the option that the user
  26                                            will see.
  27     type: **bool**                      <- Valid type are: bool (checkbox) and enum
  28                                         <- (dropdown).
  29     help: **Greet the World**           <- Help text that is displayed when hovering on the
  30                                            option.
  31 ```