Skip to content

Commit

Permalink
Update readme.md (FOME-Tech#492)
Browse files Browse the repository at this point in the history
* Update readme.md

Readme was out of date:

bat->sh
rusefi->fome

* Update readme.md

s/bat/sh
  • Loading branch information
alrijleh authored Oct 3, 2024
1 parent 1287f1e commit b40e7cd
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions firmware/tunerstudio/readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# TunerStudio (TS)

This directory contains the initialization and configuration files for the
rusEFI interface to TunerStudio.
FOME interface to TunerStudio.

The primary contents are a set `rusefi*.ini` initialization files, used to
The primary contents are a set `fome_*.ini` initialization files, used to
configure TunerStudio to setup and monitor a specific ECU board. These are
the only files a typical end user needs.

Expand All @@ -17,7 +17,7 @@ The initialization files are automatically generated from a combination
of input files located both in this directory and in the board-specific
directories .

`rusefi*.ini` files are generated based on the following four inputs:
`fome_*.ini` files are generated based on the following four inputs:
1) `rusefi_config.txt` contains configuration region definition in proprietary text format.
2) `tunerstudio.template.ini` contains the UI - all the menus and dialogs. UI definition starts at `menuDialog = main`
line - here you will see all top level menus defined with internal IDs and visible text labels.
Expand All @@ -26,9 +26,9 @@ line - here you will see all top level menus defined with internal IDs and visib


The combined file is generated by ConfigDefinition.jar tool.
On Windows this may be run with `gen_config.bat`.
On Linux this may be run with `gen_config.sh`.


Q: how do I offer my changes to TS project?

A: please PR only source files (tunerstudio.template.ini & rusefi_config.txt). Once merged, gen_config.bat would be executed automatically and results would be pushed by automation.
A: please PR only source files (tunerstudio.template.ini & rusefi_config.txt). Once merged, gen_config.sh would be executed automatically and results would be pushed by automation.

0 comments on commit b40e7cd

Please sign in to comment.