From 0f33e1955883166bcd2a1aad920f45f3b5cf49cb Mon Sep 17 00:00:00 2001 From: Eduardo Silva Date: Tue, 5 Nov 2024 15:50:52 +0000 Subject: [PATCH] Added the README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b68294 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# About +This project will be able to parse `.ibt` files, read live data from races and +broadcast messages to the service. Its still not very mature at all, but after +this commit I will turn it into a package instead and give it a stable API. +Will also put some examples then. + + +## The SDK +I used various sources to develop and understand how `iRacing` works, and learn +a lot with it. Once I have matured this project a bit I will document its +inner workings too. + + +## SharedMem +I vendored in the code from [hidez8891/shm](https://github.com/hidez8891/shm) +since the repo has been archived. I took the opportunity to update some of its +code.