Thanks for your interest in contributing! This started as a personal project for my family, and I'm happy to see it grow.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one.
- Be precise: Include specific error logs, your OS version, camera model, and whether you are using IR or RGB.
- Open a new issue with a clear title and detailed description.
- Explain why this enhancement would be useful to most users.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes (
make testorctest). - Format your code. We follow standard C++ conventions. If possible, run
clang-formaton your changes.
See the README.md for full installation instructions.
# 1. Build Static Dependencies (Required once)
./scripts/build_opencv.sh
# 2. Build Project
mkdir build && cd build
cmake .. -DENABLE_TESTING=ON
make
# Run tests
./linuxcampam_testsBefore diving into the code, we recommend reading docs/ARCHITECTURE.md. It contains diagrams showing how the PAM module, Daemon, and AI Engine interact, along with a "Source Code Map" to help you navigate the files.
If you discover a potential security, privacy, or data handling issue, please refer to our Security Policy.