Salut Gilles

2023-01-26 20:16:21 +00:00
commit 4506f07987
21 changed files with 2656 additions and 0 deletions
@@ -0,0 +1,45 @@
+# Gilles
+ncurses based telemetry monitor for racing sims
+
+## Features
+- Updates at 120 frames per seconds.
+- Modular design for support with various titles
+
+## Dependencies
+- argtable2
+- libconfig
+- slog (static)
+- [wine-linux-shm-adapter](https://github.com/spacefreak18/wine-linux-shm-adapter)
+- [simapi](https://github.com/spacefreak18/simapi)
+
+## Building
+This code depends on the shared memory data headers in the simapi [repo](https://github.com/spacefreak18/simapi). When pulling lastest if the submodule does not download run:
+```
+git submodule sync --recursive
+git submodule update --init --recursive
+```
+Then to compile simply:
+```
+mkdir build; cd build
+cmake ..
+make
+```
+## Testing
+
+### Static Analysis
+```
+    mkdir build; cd build
+    make clean
+    CFLAGS=-fanalyzer cmake ..
+    make
+```
+### Valgrind
+```
+    cd build
+    valgrind -v --leak-check=full --show-leak-kinds=all --suppressions=../.valgrindrc ./gilles play
+```
+
+## ToDo
+ - GUI
+ - Actual telemetry to compare against self and other drivers
+ - much, much more