Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #55

Merged
merged 1 commit into from
Jun 7, 2023
Merged

Update README.md #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 3 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,19 @@

Repository for the storage of config.h files for board settings.

## Version Comments (simple rules engine)

The file can include comments that will be utilised by the https://build.betaflight.com API so as to produce a unique file for a given version as requested by the Makefile when a user begins a build.

Version comment details are as follows:

`// version <= 4.1.0`

all subsequent lines (until next rule is hit) are included for any version request less than or equal to 4.4.1

`// version == 4.5.0`

all subsequent lines (until next rule is hit) are included for version 4.5.0

`// version >= 4.5.0`

all subsequent lines (until next rule is hit) are included for any version request greater than or equal to 4.5.0

## How to use - Firmware

The repository cannot be used directly (unless you get fancy with SYM LINKS). The reason is it needs the API to interpret the config files, and return content based on the requested version (see the version rules above). The structure is also slightly different in the repository as the board name directories include the manufacturer code (similar to the unified targets repository).
The config repository will be used directly by the firmware.

You need to hydrate the target list first with:

```
> make configs
```

Let's say the current version.h file has the version 4.5.0 in it. Then when you make a build for a specific target configuration e.g.
Then you can make a build for a specific target configuration e.g.
```
> make BETAFLIGHTF4
```
the make file will create `./src/config/4.5.0/BETAFLIGHTF4/` and download the `config.h` file from the API (passing the version and the board as required). The API will produce a `config.h` based on the content rules described above.