diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d22b40 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# HsMouse +Experimental control software for robotics, tested on Raspberry Pi 5. + +## System Configuration: +To configure the system, the files in the `sysconf` directory must be +installed: + +1. Copy the UDEV `*.rule` files into `/etc/udev/rules.d`. +2. Copy `config.txt` to `/boot`. +3. Reboot the Raspberry Pi for the changes to take effect. + +## GPIO and PWM Access Without Root: +To enable GPIO and PWM access without root privileges on the Raspberry Pi 5, +follow these steps: + +1. Create two new user groups: `gpiod` and `pwm`. +2. Add your user to both groups. +3. The UDEV rules installed previously will grant the `gpiod` and `pwm` user +groups permission to access the respective subsystems. + +This configuration ensures that GPIO and PWM operations can be performed +without needing root access. + +## Build Instructions: +1. Install [`stack`](https://docs.haskellstack.org/en/stable/). It’s +recommended to use [`ghcup`](https://www.haskell.org/ghcup/) for installation. +2. Run `stack build` to compile the libraries and executables. + +> Note: You may need to install system dependencies on your host first (e.g., +> `libgpiod`, etc.) |