moritzruth/deckster
1
0
Fork 0
Code Issues Pull requests Activity

Update README.md

Browse source
This commit is contained in:
Moritz Ruth 2024-07-09 22:59:59 +02:00 • committed by git.moritzruth.de
parent 526ea8ea70
commit 659d937280
Signed by: git.moritzruth.de
GPG key ID: AF72C6EBB4B578A7
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -2,21 +2,25 @@
> A custom Loupedeck driver and declarative backend written in Rust. > A custom Loupedeck driver and declarative backend written in Rust.
## To do ## To do
- Make the `playerctl` handler independent of… playerctl. Use the [`mpris` crate](https://lib.rs/crates/mpris) directly instead. - Make the `playerctl` handler independent of… playerctl. Use the [`mpris` crate](https://lib.rs/crates/mpris) directly instead.
- Implement scrolling - Implement scrolling
- Move loupedeck_serial and pa_volume_interface out of this repository. - Move loupedeck_serial and pa_volume_interface out of this repository.
- Publish libraries to crates.io - Publish libraries to crates.io
- Move handlers to their own repositories - Move handlers to their own repositories
## Contributing ## Contributing
### Terminology ### Terminology
- `handler runner`: Node that is running handlers. - `handler runner`: Node that is running handlers.
- `handler host`: A `handler runner` that is not the `coordinator`. - `handler host`: A `handler runner` that is not the `coordinator`.
- `coordinator`: Node to which the Loupedeck device is physically connected. Can be a `handler runner`. - `coordinator`: Node to which the Loupedeck device is physically connected. Can be a `handler runner`.
### The different types of `unwrap` ### The different types of `unwrap`
- `expect("<reason>")`: The author thinks that unwrapping will never fail because of `<reason>`. - `expect("<reason>")`: The author thinks that unwrapping will never fail because of `<reason>`.
- `unwrap()`: The author assumes that unwrapping will never fail ~~but explaining why is either obvious or too complicated~~ and it’s obvious why. - `unwrap()`: The author assumes that unwrapping will never fail ~~but explaining why is either obvious or too complicated~~ and it’s obvious why.
- `unwrap_todo()`: The author has not yet thought about how to handle this value being `None` or `Err`. - `unwrap_todo()`: The author has not yet thought about how to handle this value being `None` or `Err`.
@ -28,3 +32,8 @@
[foxxyz’s `loupedeck` library for JavaScript](https://github.com/foxxyz/loupedeck) [foxxyz’s `loupedeck` library for JavaScript](https://github.com/foxxyz/loupedeck)
(licensed under the [MIT license](https://github.com/foxxyz/loupedeck/blob/e41e5d920130d9ef651e47173c68450b9c832b96/LICENSE)) (licensed under the [MIT license](https://github.com/foxxyz/loupedeck/blob/e41e5d920130d9ef651e47173c68450b9c832b96/LICENSE))
was used as a reference for and inspired the design of `loupedeck_serial`. was used as a reference for and inspired the design of `loupedeck_serial`.
## License
This project is available under the permissive [Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0).