rusefi
/
rusefi
mirror of https://github.com/rusefi/rusefi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

only:docs

This commit is contained in:
rusefillc 2024-02-21 17:30:41 -05:00
parent ea41335d8c
commit 19fb7abf44
3 changed files with 11 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
firmware/readme.md
View File

@ -1,40 +1,24 @@
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)
See also [../unit_tests](../unit_tests)
This directory contains the source code for the RusEFI firmware.
The ideal is that typical end users should be able to use pre-built
firmware. They should not need to modify or even rebuild from the
source code for basic use, but building from the source code provides
the opportunity for optimization, supporting unexpected engine
configurations, and specialized enhancements.
This directory contains the source code for the rusEFI embedded firmware.
TL;DR
``make PROJECT_BOARD=microrusefi PROJECT_CPU=ARCH_STM32F4``
``make``
# Environment
Rebuilding from source code requires this firmware, a modern C/C++
compiler for embedded ARM systems, and a platform that supports 'make'
based builds.
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)
See setup_linux_environment.sh
Windows development is fully supported with Cygwin, WSL or Linux is recommended due to poor NTFS performance.
While many compilers have the potential to work, we suggest using the
official ARM version of GCC available at launchpad.net.
Linux and MacOS systems should have the software development tools,
primarily 'make', pre-installed or readily installed. MS-Windows
requires selecting and installing a Unix-compatible system environment.
Note that the developers are volunteers, with varied motivations.
These motivations often include using leading-edge language and build
system concepts, requiring recent versions of tools. Should you
encounter build problems, review the latest version of this document.
See also [../simulator](../simulator)
See also [../unit_tests](../unit_tests)

2
simulator/readme.md
View File

@ -7,8 +7,6 @@ Simulator runs a subset of ECU on your pc, easier to debug some things, tighter
* mocked outputs
* SocketCAN integration on Linux
One of ways to mock analog sensors
```
// see SensorType.java for numeric ordinals

2
unit_tests/readme.md
View File

@ -1,6 +1,6 @@
See https://github.com/rusefi/rusefi/wiki/Dev-Quality-Control
TL, DR: just follow [tests](tests) folder as examples.
TL, DR: just follow [tests](tests) folder as examples. gcc/makefile/gtest
1. Run 'make' to build desktop binary.
1. Execute rusefi_test binary on your PC/Mac, it's expected to say SUCCESS and not fail :) Googletest will also print results summary.