rusefi_documentation/HOWTO-contribute-to-firmwar...

28 lines
1.4 KiB
Markdown
Raw Normal View History

# HOWTO Contribute to Firmware
2023-01-13 06:29:39 -08:00
The majority of rusEFI code is written in very plain C++ ("C with classes"),
with rusEFI console and some code generating tools written in java.
2020-02-22 19:36:21 -08:00
2023-01-02 11:22:23 -08:00
Most of the needs are within the C/C++ firmware and automated testing.
2020-02-22 19:36:21 -08:00
A good first contribution could be adding some automated testing into [https://github.com/rusefi/rusefi/tree/master/unit_tests/tests](https://github.com/rusefi/rusefi/tree/master/unit_tests/tests)
2020-02-22 19:36:21 -08:00
For current coverage report see [https://rusefi.com/docs/unit_tests_coverage/](https://rusefi.com/docs/unit_tests_coverage/)
2020-02-22 19:36:21 -08:00
Doxygen source code documentation is found [here.](https://rusefi.com/docs/html/)
2023-01-13 06:29:39 -08:00
Primary tool-chain is GCC+Eclipse but IAR is also supported.
Linux is the preferred build environment, Windows Subsystem for Linux (WSL) works fine.
To setup development environment use [setup_linux_environment.sh](https://github.com/rusefi/rusefi/blob/master/firmware/setup_linux_environment.sh)
Testing coverage open tickets: [https://github.com/rusefi/rusefi/labels/automated_testing](https://github.com/rusefi/rusefi/labels/automated_testing)
2020-02-22 19:36:21 -08:00
All open tickets: [https://github.com/rusefi/rusefi/issues](https://github.com/rusefi/rusefi/issues)
2020-02-22 19:36:21 -08:00
2021-02-17 14:50:11 -08:00
See [Try It](Try-It) for how to work on rusEFI code with zero or minimal hardware.
[Click here for a Q&A on source code.](http://rusefi.com/forum/viewtopic.php?f=5&t=10)
[Some random tips](Dev-Tips)