rhetenor/flippr-code
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jonas Zeunert
2024-02-17 16:08:46 +01:00
parent 185f8874cb
commit 3942a8f2d4
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -4,8 +4,12 @@ This is a driver written to control Zaccaria pinball machines from the 2nd Gener
An example game implementation for the Zaccaria Pinball Champ '82 can be found at [[flippr-game|https://gitlab.rhetenor.de/rhetenor/flippr-game]]. An example game implementation for the Zaccaria Pinball Champ '82 can be found at [[flippr-game|https://gitlab.rhetenor.de/rhetenor/flippr-game]].
## Build Instructions ## Build Instructions
By default a static library gets build together with a networking target which enables communication over a UNIX Socket, for possible games.
### Library ### Dependencies
* wiringPi
### Build
To build the flippr-driver library run the following commands: To build the flippr-driver library run the following commands:
```sh1 ```sh1
$ cd flippr-code/FlippR-Driver/build $ cd flippr-code/FlippR-Driver/build
@@ -18,4 +22,9 @@ The library uses wiringPi Pin numbering important for the config files
We added a script /usr/bin/reset_flippr this can be found in the repo and must be chosen in /etc/rc.local. It prevents the solenois from burning! We added a script /usr/bin/reset_flippr this can be found in the repo and must be chosen in /etc/rc.local. It prevents the solenois from burning!
### Networking #### Build Options
* `-DCROSS_COMPILE` Cross compile for raspberry pi. Default: Off
* `-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