Files
TEF6686_ESP32/README.md
Mateusz Walkowiak d04b7a1c8a Update README.md
add badges for a test
2023-07-20 21:28:50 +02:00

34 lines
2.2 KiB
Markdown

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/PE5PVB/TEF6686_ESP32/issues)
[![HitCount](https://hits.dwyl.com/PE5PVB/TEF6686_ESP32.svg)](https://hits.dwyl.com/PE5PVB/TEF6686_ESP32)
# Note:
The version in the repository is an ongoing development. It could and will contain bugs. To make sure you use the latest fully tested firmware, check the releases!
# TEF6686_ESP32
Advanced Tuner software for NXP TEF668x tuners with ESP32 board\
Based on Catena / NXP semiconductors API
More information: https://www.pe5pvb.nl/tef6686/
## Wiki
- [About the software & features](https://github.com/PE5PVB/TEF6686_ESP32/wiki)
- [Getting started](https://github.com/PE5PVB/TEF6686_ESP32/wiki#getting-started)
- [How to install the software](https://github.com/PE5PVB/TEF6686_ESP32/wiki/Installing-the-software)
## Contributing
We are open for a new ideas in our project. Feel free to share your thoughts in [Discussions](https://github.com/PE5PVB/TEF6686_ESP32/discussions).\
You can also contribute your own code using [Pull Requests](https://github.com/PE5PVB/TEF6686_ESP32/pulls). We will review it and merge into main branch.
You are using our software and you found a difficulty? Please create new [issue](https://github.com/PE5PVB/TEF6686_ESP32/issues) and describe your problem.
We also would like to invite you to join our Discord community where we share our ideas and help each other with some issues.\
[<img alt="Join the TEF6686 Discord community!" src="https://i.imgur.com/BYqhuLI.png">](https://discord.gg/ZAVNdS74mC)
Special thanks to all [contributors](https://github.com/PE5PVB/TEF6686_ESP32/graphs/contributors). You are awesome! ❤️
## License
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.