rusefi/firmware/readme.md

End users should be able to use pre-built firmware. They should not need to build or modify the source code.
See https://github.com/rusefi/rusefi/wiki/Download

See also https://github.com/rusefi/rusefi/wiki/Dev-Quick-Start

[Doxygen](https://rusefi.com/docs/html/) <<< landing page has best implementation introduction.

[Q&A on source code](https://rusefi.com/forum/viewtopic.php?f=5&t=10)

This directory contains the source code for the rusEFI embedded firmware.

TL;DR

``make``

# Environment

Embedded firmware is build on top of https://www.chibios.org/ with plain Makefile gcc version 12 (See https://github.com/rusefi/rusefi/blob/master/.github/workflows/hardware-ci.yaml to confirm current GCC version)

Windows development is fully supported with Cygwin, WSL or Linux is recommended due to poor NTFS performance.

See also [../simulator](../simulator)

See also [../unit_tests](../unit_tests)
only:docs 2024-02-21 14:30:41 -08:00			`End users should be able to use pre-built firmware. They should not need to build or modify the source code.`
			`See https://github.com/rusefi/rusefi/wiki/Download`

			`See also https://github.com/rusefi/rusefi/wiki/Dev-Quick-Start`
unit tests code coverage #653 2019-08-25 20:31:39 -07:00
Update readme.md 2023-04-19 09:08:24 -07:00			`[Doxygen](https://rusefi.com/docs/html/) <<< landing page has best implementation introduction.`
unit tests code coverage #653 2019-08-25 20:31:39 -07:00
			`[Q&A on source code](https://rusefi.com/forum/viewtopic.php?f=5&t=10)`

only:docs 2024-02-21 14:30:41 -08:00			`This directory contains the source code for the rusEFI embedded firmware.`
skeleton & docs (#995) * Documentation additions and clarifications. Added config/boards/skeleton/ as an example and starting point for board-specific support. * Describe where the generated files came from. * Minor rewording * Delete mistakenly added emacs backups * Added an overall description and build notes 2019-11-03 05:41:14 -08:00
			`TL;DR`

only:docs 2024-02-21 14:30:41 -08:00			``make``
skeleton & docs (#995) * Documentation additions and clarifications. Added config/boards/skeleton/ as an example and starting point for board-specific support. * Describe where the generated files came from. * Minor rewording * Delete mistakenly added emacs backups * Added an overall description and build notes 2019-11-03 05:41:14 -08:00
docs 2021-07-09 10:29:03 -07:00			`# Environment`
skeleton & docs (#995) * Documentation additions and clarifications. Added config/boards/skeleton/ as an example and starting point for board-specific support. * Describe where the generated files came from. * Minor rewording * Delete mistakenly added emacs backups * Added an overall description and build notes 2019-11-03 05:41:14 -08:00
only:docs 2024-02-21 14:30:41 -08:00			`Embedded firmware is build on top of https://www.chibios.org/ with plain Makefile gcc version 12 (See https://github.com/rusefi/rusefi/blob/master/.github/workflows/hardware-ci.yaml to confirm current GCC version)`
docs 2021-07-09 10:29:03 -07:00
only:docs 2024-02-21 14:30:41 -08:00			`Windows development is fully supported with Cygwin, WSL or Linux is recommended due to poor NTFS performance.`
skeleton & docs (#995) * Documentation additions and clarifications. Added config/boards/skeleton/ as an example and starting point for board-specific support. * Describe where the generated files came from. * Minor rewording * Delete mistakenly added emacs backups * Added an overall description and build notes 2019-11-03 05:41:14 -08:00
only:docs 2024-02-21 14:30:41 -08:00			`See also [../simulator](../simulator)`
skeleton & docs (#995) * Documentation additions and clarifications. Added config/boards/skeleton/ as an example and starting point for board-specific support. * Describe where the generated files came from. * Minor rewording * Delete mistakenly added emacs backups * Added an overall description and build notes 2019-11-03 05:41:14 -08:00
only:docs 2024-02-21 14:30:41 -08:00			`See also [../unit_tests](../unit_tests)`