Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.37 KB

Contributing.md

File metadata and controls

22 lines (15 loc) · 1.37 KB
Raw

Currently, the codebase is very messy. I plan to refactor most of it as we make the switch to Tauri (a new UI framework).

Setting up the Dev Enviornment

Rust

Rust is the main language used in this program. Before contributing, make sure you have a solid understanding of Rust, which you can learn how to set up and use in the Rust Book.

Once you've cloned the repository, simply open a terminal and type cargo run to compile and run the program.

I recommend using VSCode with the Rust Analyzer and Crates extension, but you can use whatever you prefer.

Build Dependencies

Clang is required to build the bindings to SimConnect. You can grab the latest LLVM from here, and add the bin folder to your PATH enviornmental variable.

SimConnect.dll is included in this repository.

Pull Request Workflow

  • Create your own fork of the repository.
  • Commit regularly with small changes to your fork.
  • When finished, open a pull request clearly describing every change you've made with a descriptive title.
  • Wait for your PR to get reviewed and be prepared to answer any questions or make changes.