Skip to content

Commit 6a97e05

Browse files
authored
Merge pull request #338 from klutvott123/update-readme
2 parents fd07fbf + 829c1cb commit 6a97e05

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
# betaflight-tx-lua-scripts
2-
3-
## How to download the scripts
4-
5-
Please visit the [releases page](https://github.com/betaflight/betaflight-tx-lua-scripts/releases) to download a zip file containing latest version.
1+
# Betaflight TX Lua Scripts
62

73
## Firmware Considerations
84

9-
- Betaflight - 4.1.0 or newer. As a best practice, it is recommended to use the most recent stable release of Betaflight to obtain the best possible results;
5+
- Betaflight - As a best practice, it is recommended to use the most recent stable release of Betaflight to obtain the best possible results;
106
- OpenTX - 2.3.4 or newer;
117
- Crossfire TX / RX - v2.11 or newer;
128
- FrSky TX / RX - While most receivers work fine, it's recommended to update the XSR family of receivers to their most recent firmware version to correct any known bugs in SmartPort telemetry.
@@ -15,9 +11,9 @@ Please visit the [releases page](https://github.com/betaflight/betaflight-tx-lua
1511

1612
**!! IMPORTANT: DON'T COPY THE CONTENTS OF THIS REPOSITORY ONTO YOUR SDCARD !!**
1713

18-
Unzip the files from the link above and drag the contents to your radio. If you do this correctly, the SCRIPTS directory will merge with your existing directories, placing the scripts in their appropriate paths. You will know if you did this correctly if the `bf.lua` file shows up in your `/SCRIPTS/TOOLS` directory.
14+
Download a zip file containing the latest version from the [releases page](https://github.com/betaflight/betaflight-tx-lua-scripts/releases).
1915

20-
The src directory is not required for use and is only available for maintenance of the code. While it may work to use this directory, you may encounter memory issues on your transmitter.
16+
Unzip the files from the link above and drag the contents of the `obj` folder to your radios SD card. If you do this correctly, the `SCRIPTS` directory will merge with your existing directories, placing the scripts in their appropriate paths. You will know if you did this correctly if the `bf.lua` file shows up in your `/SCRIPTS/TOOLS` directory.
2117

2218
### How to install
2319

@@ -46,8 +42,14 @@ Due to issues with input mapping and memory overruns, running the script as a te
4642

4743
If you are using a VTX that supports the SmartAudio or Tramp protocols then bands and channels etc. are managed using VTX tables since Betaflight version 4.1.0. The script will be downloading and storing the current VTX table for every model the first time the model is connected and the script is run. If you change the VTX table, you have to re-load the updated VTX table in the script, by choosing the 'vtx tables' option in the function menu.
4844

45+
### Background script
46+
The optional background script offers RTC synchronization and RSSI through MSP. It can be setup as a special or global function in OpenTX. The image below shows how to run the background script as a special function.
47+
48+
![Background script setup](docs/assets/images/background_script_setup.png)
49+
50+
4951
## Building from source
5052

5153
- Be sure to have `make` and `luac` in version 5.2 installed in the path
5254
- Run `make` from the root folder
53-
- The installation files will be created a the `obj` in the root folder. Copy the files to your transmitter as instructed in the '[Installing](#installing)' section below as if you unzipped from a downloaded file.
55+
- The installation files will be created in the `obj` folder. Copy the files to your transmitter as instructed in the '[Installing](#installing)' section as if you unzipped from a downloaded file.
1.32 KB
Loading

0 commit comments

Comments
 (0)