summaryrefslogtreecommitdiff
path: root/util/coreboot-configurator/src/README.md
blob: e3386242a2b727f2f5dc86e3ff1712da01526c7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Categories ![alt text](images/StarLabs_Logo.png "Star Labs Systems")

CMOS values should be added to [categories.yaml](src/application/categories.yaml].

This allows `coreboot-configurator` to display them in a relavant tab, with a nice
name and help text. Without this, they will still be visible in the **Raw** tab.

An example entry is below:
```
processor:
  displayName: Processor
  me_state:
    displayName: Intel Management Engine
    type: bool
    help: Enable or disable the Intel Management Engine
```

To explain the options:
```
**tabgroup**:				<- This is the reference to the tab group
  displayName: **Hello World**		<- This is the name of the group that the user
					   will see
  **setting_1**:			<- This is the value that should match the CMOS
					   option.
    displayName: **Hi World**		<- This is the name of the option that the user
					   will see.
    type: **bool**			<- Valid type are: bool (checkbox) and enum
					<- (dropdown).
    help: **Greet the World**		<- Help text that is displayed when hovering on the
					   option.
```