Skip to content

Commit 7678337

Browse files
authored
Update Readme with build steps and also add TODO (#135)
Signed-off-by: Jagadeesh Pagadala <jpagadal@qti.qualcomm.com>
1 parent 0db7bfa commit 7678337

2 files changed

Lines changed: 23 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ This project depends on the following external libraries:
2828
```
2929

3030
## Build and install Instructions
31+
* Clone
32+
```bash
33+
git clone https://github.com/qualcomm/userspace-resource-manager.git
34+
```
3135
* Create a build directory
3236
```bash
3337
rm -rf build && mkdir build && cd build
@@ -37,11 +41,18 @@ Default Build
3741
```bash
3842
cmake .. -DCMAKE_INSTALL_PREFIX=/
3943
```
44+
# Optional Components
45+
46+
The project provides optional components that can be enabled using CMake flags:
4047

41-
With classifier support enabled:
48+
- **Classifier** (runtime classification module)
49+
- **Test Framework** (unit and integration tests)
50+
51+
To enable both:
4252
```bash
43-
cmake .. -DCMAKE_INSTALL_PREFIX=/ -DBUILD_CLASSIFIER=ON
53+
cmake .. -DCMAKE_INSTALL_PREFIX=/ -DBUILD_CLASSIFIER=ON -DBUILD_TESTS=ON
4454
```
55+
4556
* Build the project
4657
```bash
4758
cmake --build .

TODO.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
1. Core Dev tasks
2+
- SeLinux Rules enablement
3+
- Enable Classifier on meta-qcom builds
4+
- Analyze CodeQL reported issues
5+
6+
2. Process tasks (GitHub actions and repo workflow)
7+
- Enable Axiom CI tests
8+
- Orbit Integration
9+
- Submit FastText Recipe file to Yocto community
10+
- Integrate and Enable ARMOR

0 commit comments

Comments
 (0)