Is your feature request related to a problem? Please describe.
This is request to ease the onboarding when first using this library by provinding some examples (which?) as entry points to quickly test installation.
I've just installed this library on my ubuntu machine, with the plan to develop a plugin for a 3rd party application.
Having followed the installation procedure, I now want to check that the install went well (eg. external requirements such as libhidapi-libusb0 are present, udev rules set...)
For this, I ran the Deck Info Example from the documentation page.
Describe the solution you'd like
I propose to add the above linked Deck Info example as an entry point, such that it can be directly called from the command line after installation as, for example, streamdeck-list:
$ streamdeck-list
Stream Deck Neo
- ID: 1-5:1.0
- Serial: ''
- Firmware Version: ''
- Key Count: 8 (in a 2x4 grid)
- Key Images: 96x96 pixels, JPEG format, rotated 0 degrees, mirrored horizontally/verticallyOther examples could also be proposed, but I like that the Deck Info does not require further dependencies.
I also like that feature as it allows to quickly check that devices are available (alternative would be lsusb).
Describe alternatives you've considered
The current status is also very nice, with several examples clearly listed in the project's documentation. Thank you!
Additional context
I'm happy to contribute a PR, with some guidance as I'm new to this project.
Cheers,
Cyril
Is your feature request related to a problem? Please describe.
This is request to ease the onboarding when first using this library by provinding some examples (which?) as entry points to quickly test installation.
I've just installed this library on my ubuntu machine, with the plan to develop a plugin for a 3rd party application.
Having followed the installation procedure, I now want to check that the install went well (eg. external requirements such as
libhidapi-libusb0are present, udev rules set...)For this, I ran the Deck Info Example from the documentation page.
Describe the solution you'd like
I propose to add the above linked Deck Info example as an entry point, such that it can be directly called from the command line after installation as, for example,
streamdeck-list:$ streamdeck-list Stream Deck Neo - ID: 1-5:1.0 - Serial: '' - Firmware Version: '' - Key Count: 8 (in a 2x4 grid) - Key Images: 96x96 pixels, JPEG format, rotated 0 degrees, mirrored horizontally/verticallyOther examples could also be proposed, but I like that the Deck Info does not require further dependencies.
I also like that feature as it allows to quickly check that devices are available (alternative would be
lsusb).Describe alternatives you've considered
The current status is also very nice, with several examples clearly listed in the project's documentation. Thank you!
Additional context
I'm happy to contribute a PR, with some guidance as I'm new to this project.
Cheers,
Cyril