diff --git a/README.md b/README.md index b7ae4d8..30af9bb 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@ An example game implementation for the Zaccaria Pinball Champ '82 can be found a By default a static library gets build together with a networking target which enables communication over a UNIX Socket, for possible games. ### Dependencies - * wiringPi + * wiringPi [^1] + * Boost: program_options thread timer chrono filesystem + * libthread ### Build To build the flippr-driver library run the following commands: @@ -27,4 +29,9 @@ We added a script /usr/bin/reset_flippr this can be found in the repo and must b * `-DBUILD_SHARED_LIB` Build a shared library. Default: Off * `-DENABLE_TESTING` Enables Tests after build. Default: On * `-DBUILD_NETWORKING` Builds the networking target binary. Default: On - * `-DBUILD_CLI` Build a basic TUI to control the flipper by hand. Default: Off \ No newline at end of file + * `-DBUILD_CLI` Build a basic TUI to control the flipper by hand. Default: Off + + [^1]: Please note that wiringPi is deprecated and might not work on future releases of raspbian and most probably not on a Raspberry Pi5 and future versions. + + ## Usage + When build with the networking target, the driver is accessible via a simple REST API. An example connector writtin in Python can be found in the TUI [[FlippR_Networking.py|https://gitlab.rhetenor.de/rhetenor/flippr-code/src/branch/master/cli/FlippR_Networking.py]] \ No newline at end of file