Skip to content

ericmqt/SharpRacer

Repository files navigation

SharpRacer

GitHub License GitHub Actions Workflow Status SharpRacer All Libraries Code Coverage

SharpRacer is a modern, high-performance .NET library for interacting with the iRacing racing simulator.

This project is under active development and is currently in a pre-release state.

Getting Started

TODO

Testing

SharpRacer includes an automated test suite for the SharpRacer library and the source generator. The tests can be run using the dotnet test command from the repository directory.

Running the Test Suite

dotnet restore
dotnet test

Generate Code Coverage Reports

This repository uses ReportGenerator as a dotnet local tool for generating code coverage reports. Before generating code coverage reports, you'll need to ensure it is installed for your local copy of the repository:

dotnet tool restore

Generate the code coverage reports using the eng\GenerateCodeCoverageReport.ps1 PowerShell script:

.\eng\GenerateCodeCoverageReport.ps1 -OutputDirectory .\artifacts\test -SharpRacer -SourceGenerator -Html

Contributing

This project is not accepting contributions at the moment. I will begin taking contributions once the first release is completed and published.

License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.

Support

If you like this project, found it useful, and want to support my work, you can buy me a coffee. You don't have to, though. I promise I won't be mad if you don't.

About

A modern, high-performance .NET library for interacting with the iRacing racing simulator

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published