Skip to content

Commit 4769cc6

Browse files
committed
Update README.md and CONTRIBUTING.md
1 parent 6b99f01 commit 4769cc6

2 files changed

Lines changed: 55 additions & 37 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contributing to Qualcomm Test Automation Controller (QTAC)
1+
## Contributing to Qualcomm USB Kernel Drivers
22

33
Hi there!
44

@@ -9,19 +9,19 @@ Your help is essential for keeping this project great and for making it better.
99
In general, contributors should develop on branches based off of `develop` and pull requests should be made against `develop`.
1010

1111
## Submitting a pull request
12-
1. Please read our [code of conduct](CODE-OF-CONDUCT.md) and [license](LICENSE).
12+
1. Please read our [code of conduct](CODE-OF-CONDUCT.md) and [license](LICENSE.txt).
1313

14-
2. [Fork](https://github.com/qualcomm/qcom-test-automation-controller/fork) and clone the repository.
14+
2. [Fork](https://github.com/qualcomm/qcom-usb-kernel-drivers/fork) and clone the repository.
1515
```bash
16-
git clone https://github.com/<username>/qcom-test-automation-controller.git
16+
git clone https://github.com/<username>/qcom-usb-kernel-drivers.git
1717
```
1818
3. Create a new branch based on `develop`:
1919
```bash
2020
git checkout -b <my-branch-name> develop
2121
```
2222
4. Create an upstream `remote` to make it easier to keep your branches up-to-date:
2323
```bash
24-
git remote add upstream https://github.com/qualcomm/qcom-test-automation-controller.git
24+
git remote add upstream https://github.com/qualcomm/qcom-usb-kernel-drivers.git
2525
```
2626

2727
5. Make your changes, add tests, and make sure tests passes.
@@ -43,7 +43,7 @@ In general, contributors should develop on branches based off of `develop` and p
4343

4444
The `-u` is shorthand for `--set-upstream`. This will set up the tracking reference so subsequent runs of `git push` or `git pull` can omit the remote and branch.
4545

46-
9. [Submit a pull request](https://github.com/qualcomm/qcom-test-automation-controller/pulls) from your branch to `develop`.
46+
9. [Submit a pull request](https://github.com/qualcomm/qcom-usb-kernel-drivers/pulls) from your branch to `develop`.
4747

4848
10. Pat yourself on the back and wait for your pull request to be reviewed.
4949

README.md

Lines changed: 49 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ Qualcomm kernel drivers provide logical representations of Qualcomm chipset-enab
33
The project is organized to facilitate easy compilation, testing, and integration into custom hardware solutions.
44

55
## Key Features
6-
- Supports Both Windows and Linux platforms.
7-
- Supports Windows on Snapdragon hosts and both X64/X86/ARM64 devices.
8-
- WHQL-certified and optimized for the latest Windows 11 operating systems.
9-
- Compatible with existing tools like QUTS, QDL, Qualcomm Device Launcher, and more.
6+
- Supports Windows and Linux platforms.
7+
- Supports X64/X86/ARM64 architectures.
8+
- WHQL-certified on the latest Windows operating systems.
9+
- Compatible with Qualcomm tools like QUTS, QXDM, PCAT, and more.
10+
- Compatible with terminal emulators like PuTTY and Tera Term.
1011

1112
## Repository Structure
1213

@@ -19,55 +20,72 @@ The project is organized to facilitate easy compilation, testing, and integratio
1920
└─ ... # Other files and directories
2021
```
2122

22-
## Software install guide
23+
## Build Instructions
2324

2425
### Prerequisites
2526

2627
#### Windows
2728

2829
- Visual Studio 2019 (or later) with **Desktop development with C++** workload.
29-
- Windows Driver Kit for Windows 10, version 1809 or later
30-
- Administrator rights for driver installation.
31-
- Perl v5.26.3 or later
30+
- Windows Driver Kit for Windows 10, version 1903 (18362.1) or later.
3231

3332
#### Linux
3433

3534
- GNU Make, GCC/Clang.
3635
- Kernel headers for the target kernel version (`linux-headers-$(uname -r)`).
3736

38-
### Building the Drivers
37+
### Build Steps
3938

4039
#### Windows
41-
Clone the repository
42-
43-
```bash
44-
git clone https://github.com/microsoft/vcpkg.git
45-
```
46-
Navigate to directory where the code was cloned `src\windows`
47-
48-
From the project root, open the .sln file with Visual Studio
49-
50-
In Visual Studio, select `Build` > `Build Solution` from the top menu.
51-
52-
Compiled binaries will be located in a path based on build configuration, for example:
53-
```bash
54-
<ProjectRootDir>\x64\Debug\
55-
<ProjectRootDir>\x64\Release\
56-
```
40+
1. Clone the repository
41+
```bash
42+
git clone https://github.com/qualcomm/qcom-usb-kernel-drivers.git
43+
```
44+
2. Navigate to directory where the code was cloned
45+
```bash
46+
cd /src/windows/<project-name>
47+
```
48+
3. From the project root, open the .vcxproj file in Visual Studio.
49+
50+
4. In Visual Studio, select `Build` > `Build Solution` from the top menu.
51+
52+
The output binaries are generated in a path depends on the chosen build configuration. For example:
53+
54+
<ProjectRootDir>\x64\Debug\
55+
<ProjectRootDir>\x64\Release\
5756
5857
#### Linux
5958
```bash
6059
cd src/linux
6160
make
6261
```
6362

64-
#### Windows command:
63+
## Install / Uninstall
64+
65+
#### Windows
6566
- Installation
67+
68+
Right click the `.inf` file in output folder and select **Install**.
69+
Or install via `pnputil`:
6670
```bash
67-
<ProjectRoot>\install\install.bat
71+
pnputil /add-driver <build_path/driver_name.inf> /install
6872
```
69-
- Uninstallation
70-
73+
- Uninstallation (Device Manager)
74+
1. Open **Device Manager**.
75+
2. Right click the target device and select **Uninstall device**.
76+
3. Check **Attempt to remove the driver for this device**.
77+
4. Click **Uninstall**.
78+
79+
- Uninstallation (Command Line)
80+
81+
1. Locate the **Published Name** of the installed driver package:
82+
```bash
83+
pnputil /enum-drivers
84+
```
85+
2. Delete the driver from system
86+
```bash
87+
pnputil /delete-driver oemxx.inf /uninstall /force
88+
```
7189
#### Linux command:
7290
Navigate to folder `src/linux`
7391

@@ -91,11 +109,11 @@ Please follow the existing coding style and run the appropriate static analysis
91109

92110
## Bug & Vulnerability reporting
93111

94-
Please review the [SECURITY.md](./.github/SECURITY.md) before reporting vulnerabilities with the project
112+
Please review the [security](./.github/SECURITY.md) before reporting vulnerabilities with the project
95113

96114
## Contributor's License Agreement
97115

98-
Please review the Qualcomm product [license](./LICENSE), [code of conduct](./CODE-OF-CONDUCT.md) & terms
116+
Please review the Qualcomm product [license](./LICENSE.txt), [code of conduct](./CODE-OF-CONDUCT.md) & terms
99117
and conditions before contributing.
100118

101119
## Contact

0 commit comments

Comments
 (0)