diff --git a/doc/index.rst b/doc/index.rst index d25540c58e509e77a7c2dd73a3c50e66c41346d3..e79dd9fc749fc66b323e619a04e55af9bdd62343 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,6 +5,12 @@ An automatic HID-BPF loader based on udev events. This repository aims to provide a simple way for users to write a HID-BPF program that fixes their device. +Note that the udev-hid-bpf repository contains there distinct components: + +- ``udev-hid-bpf`` the binary that loads HID-BPF programs +- A set of HID-BPF programs (see the ``src/bpf`` directory) +- Scaffolding to automate loading of HID-BPF programs via udev. + See :ref:`how_it_works` for details on how everything fits together. This project is written in Rust but knowledge of Rust should not be required,