2.7 KiB
my_device_handler
A library for reading Event Devices (EVDEVs).
Description
A library for reading Event Devices (EVDEVs), the devices usually found under /dev/ uses the library underlying libinput, libevdev, which is less "picky" about the kind of devices
Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Usage
int device_handler_init(); sets up the library. returns 0 ( setup error code )
int device_handler_add( const char *path); int device_handler_remove( const char *path); add/remove an event-device to the list of listened. return 0
int device_handler_poll_events( device_event** events); copies all the gathered device events into a new array at the given address and returns the item count.
void device_handler_destroy_events( device_event *events); frees the array used for copying device events, usually before its use for another copy
Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
Contributing
Fully open to contributions. What requirements?
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Authors and acknowledgment
Luca Benini [beno]
your name here
License
MA CHE NE SAPPIAMO ANCORA
Project status
se sei stanco, scrivilo in cima che qualcuno raccoglie il testimone