Skip to content

Commit d4d9169

Browse files
committed
Add start of dev docs
1 parent 15c6e6e commit d4d9169

2 files changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,5 @@ For those who want to build the project from source:
6262
- Run `build.ps1` in the root directory
6363

6464
The binaries will be in `build`.
65+
66+
## [Dev Docs](./dev_docs.md)

dev_docs.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Config Files
2+
3+
All config attributes are optional. Any omitted attributes will be ignored when matching.
4+
5+
### `device_identifiers.json`
6+
7+
- `friendly_name`: Displayed to user, not matched against
8+
- `device_desc`: Regex match (`Device Description` in pnputil_devices dump)
9+
- `manufacturer`: Regex match (`Manufacturer Name` in pnputil_devices dump)
10+
- `hardware_id`: Regex match (`Instance ID` in pnputil_devices dump)
11+
- `class_uuid`: Exact string match (`Class GUID` in pnputil_devices dump)
12+
- `inf_provider`: Regex match (`Provider Name` in pnputil_devices dump)
13+
14+
### `driver_identifiers.json`
15+
16+
- `friendly_name`: Displayed to user, not matched against
17+
- `original_name`: Regex match (`Original Name` in pnputil_drivers dump)
18+
- `provider`: Regex match (`Provider Name` in pnputil_drivers dump)
19+
- `class`: Exact string match (`Class GUID` in pnputil_drivers dump)
20+
21+
### `driver_package_identifiers.json`
22+
23+
- `friendly_name`: Displayed to user, not matched against
24+
- `display_name`: Regex match
25+
- `display_version`: Regex match
26+
- `publisher`: Regex match
27+
- `uninstall_method`: `Normal|Deferred|RegistryOnly`
28+
29+
## Github Release Instructions
30+
31+
- Set the new version in `Cargo.toml` and let it propagate to `Cargo.lock`.
32+
- PR and merge the version bump change.
33+
- Push a tag with the new version and a draft release will be created.
34+
- Review the draft and set it to latest if it looks good.
35+
- A PR will be automatically created to pull the latest changes from `main` into the config branch.

0 commit comments

Comments
 (0)