From 150c3a7f70e6a6b9514d8f84cef57a820a3f3f96 Mon Sep 17 00:00:00 2001 From: blckmn Date: Mon, 1 Jul 2024 14:30:15 +1000 Subject: [PATCH 1/2] Updating README.md with config submission notice --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 118c17e8..41f1804a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ # Target Configuration (config.h) repository -Repository for the storage of config.h files for board settings. For more information pleasee see https://betaflight.com +Repository for the storage of config.h files for board settings. For more information please see https://betaflight.com The config.h replaces the unified target configuration that is now deprecated from version 4.5.0. This frees up some flash space, and ensures defaults are baked into the build. This has been made possible due to the introduction of the cloud build service. Standard default targets are still available, but they require all configuration to be restored from a backup. Cloud build takes care of the config repository for the general user, and knowledge of it is generally not needed. The instructions here are predominantly for tinkerers and for manufacturers around creating a target. +## NOTICE + +For a target to be successfully approved it **must** adhere to both https://betaflight.com/docs/development/manufacturer/requirements-for-submission-of-targets AND https://betaflight.com/docs/development/manufacturer/config-target-guidance. + + +Pull-Requests for config submission should only be from a custom branch, and not `master` directly. + ## How to use - Firmware -The config repository will be used directly by the firmware, and is only required if you wish to use one of the targets present here when building locally. +The config repository will be used directly by the firmware, and is only required if you wish to use one of the targets present here when building locally. You need to hydrate the target list first with: @@ -16,17 +23,17 @@ You need to hydrate the target list first with: > make configs ``` -Then you can 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 -``` +``` ## Creating a config.h for a target ### TIMER_MAP The `TIMER_MAP` define sets up the timers default settings, as adjusted with the `timer` and `dma` commands in CLI. The problem is there are some magic numbers (index entries), that need to be known. - + You can activate the `timer map` CLI command (by compiling with `USE_TIMER_MAP_PRINT` defined i.e. `"EXTRA_FLAGS=-DUSE_TIMER_MAP_PRINT"`). You will need to setup (again using CLI commands) what your default `timer` and `dma` should be. You can then run the `timer map` command and it will output the correct values for inserting into the config.h file. From 3072a23f845bb4d1b51342df7000fa825da33554 Mon Sep 17 00:00:00 2001 From: blckmn Date: Mon, 1 Jul 2024 14:30:49 +1000 Subject: [PATCH 2/2] Superfluous line feed --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 41f1804a..a8dfc848 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,6 @@ Cloud build takes care of the config repository for the general user, and knowle For a target to be successfully approved it **must** adhere to both https://betaflight.com/docs/development/manufacturer/requirements-for-submission-of-targets AND https://betaflight.com/docs/development/manufacturer/config-target-guidance. - Pull-Requests for config submission should only be from a custom branch, and not `master` directly. ## How to use - Firmware