Update 'README.md'

This commit is contained in:
sebgab 2022-07-07 15:53:50 +00:00
parent e60057f640
commit f6c4f5f82e

View File

@ -3,14 +3,14 @@ This is a piece of software to control the RGB on sebaweb developed rp2040 based
## Compiling ## Compiling
Linux is currently the only supported platform, if you wish to help with porting the software to other platforms you are free to do so. Linux is currently the only supported platform, if you wish to help with porting the software to other platforms you are free to do so.
To compile the program use `cargo` To compile the program use `cargo`.
``` ```
cargo build --release cargo build --release
``` ```
## Installing on linux ## Installing on linux
Linux is currently the only supported platform, if you wish to help with porting the software to other platforms you are free to do so. Linux is currently the only supported platform, if you wish to help with porting the software to other platforms you are free to do so.
To install the software copy the compiled binary into `/usr/bin/` and the udev rule into `/etc/udev/rules.d/` To install the software copy the compiled binary into `/usr/bin/` and the udev rule into `/etc/udev/rules.d/`.
TODO: Make makefile or install script TODO: Make makefile or install script
``` ```
cargo build --release && sudo cp ./target/release/keyboard_control_software /usr/bin/. cargo build --release && sudo cp ./target/release/keyboard_control_software /usr/bin/.