Skip to content

Update readme for 1.6.0 #427

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.

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

Merged
merged 2 commits into from
Jan 20, 2022
Merged

Conversation

klutvott123
Copy link
Member

Update readme for 1.6.0

  • Removed the "how to install" section" and replaced it with a gif showing how to do it.
  • Added "how to use" section that explains and shows how to use the setup and cms scripts.
  • Renamed "Firmware considerations" to "Requirements" and added telemetry as a requirement.

https://github.com/klutvott123/betaflight-tx-lua-scripts/tree/how-to-use#readme

@klutvott123 klutvott123 added this to the 1.6 milestone Jan 20, 2022

If you copied the files correctly, you can now go into the OpenTx Tools screen from the main menu and access the Betaflight Configuration tool. The first time you run the script, a message 'Compiling...' will appear in the display before the script is started - this is normal, and is done to minimise the RAM usage of the script.
<kbd>![Betaflight setup](docs/assets/images/how_to_use.gif)</kbd>
Copy link
Member

@haslinghuis haslinghuis Jan 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<kbd>![Betaflight setup](docs/assets/images/how_to_use.gif)</kbd>
<kbd>!</kbd>[Betaflight setup](docs/assets/images/how_to_use.gif)

Is <kbd> tag needed for gif?
https://auth0.github.io/kbd/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no it isn't. It's just a simple way to have a nice border around them. Since they're mostly white they just blend in with the background if the github light theme is used. and your suggestion doesn't work 🙂

haslinghuis
haslinghuis previously approved these changes Jan 20, 2022
@klutvott123
Copy link
Member Author

Pushed a new commit adding a Betaflight Tx Lua Scripts logo to replace the text. Added one for light mode and one for dark mode. Github can select the correct one now. Looks like this

bilde

bilde

haslinghuis
haslinghuis previously approved these changes Jan 20, 2022
@klutvott123
Copy link
Member Author

Sorry, had to change the dark mode logo a little, but it's as it should be now

@haslinghuis haslinghuis merged commit e4d668b into betaflight:master Jan 20, 2022
@klutvott123 klutvott123 deleted the how-to-use branch February 16, 2023 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants