Update README.md
This commit is contained in:
parent
4cebbde389
commit
1beb3cdf0f
27
README.md
27
README.md
|
@ -2,12 +2,37 @@
|
|||
|
||||
[![Netlify Status](https://api.netlify.com/api/v1/badges/83204fc5-98b8-483c-ac69-acaa656ba9ee/deploy-status)](https://app.netlify.com/sites/speedytuner/deploys) ![master](https://github.com/speedy-tuner/speedy-tuner-cloud/actions/workflows/lint.js.yml/badge.svg?branch=master)
|
||||
|
||||
Share your Speeduino tune and logs.
|
||||
Share your [Speeduino](https://speeduino.com/) tune and logs.
|
||||
|
||||
## [https://speedytuner.cloud](https://speedytuner.cloud)
|
||||
|
||||
![Screenshot](https://speedytuner.cloud/img/screen.png)
|
||||
|
||||
## Project main goals
|
||||
|
||||
- 🚀 always free and open source (FOSS)
|
||||
- 💻 Cloud based web app with CDN
|
||||
- 🔥 `60 FPS` animations and fast load times
|
||||
- 👍 good user experience
|
||||
- 💎 intuitive, modern and responsive UI
|
||||
- 👶 easy for newcomers with tips, tools and simple diagnostics
|
||||
- 📱 touch screen friendly
|
||||
|
||||
## ECU firmware
|
||||
|
||||
- Documentation: [wiki.speeduino.com](https://wiki.speeduino.com/)
|
||||
- Source code: [noisymime/speeduino](https://github.com/noisymime/speeduino)
|
||||
|
||||
## Contributing 🤝
|
||||
|
||||
There are many ways in which you can participate in the project and every bit of help is greatly appreciated.
|
||||
|
||||
- 👋 Say Hi and start a conversation over at [Discussions](https://github.com/karniv00l/speedy-tuner/discussions)
|
||||
- 🐞 [Submit bugs and feature requests](https://github.com/karniv00l/speedy-tuner/issues)
|
||||
- 🧪 Test on different platforms, hardware and Speeduino firmware
|
||||
- 👓 Review source code
|
||||
- ⌨️ Write tests and refactor code according to best practices
|
||||
|
||||
## Development
|
||||
|
||||
Recommended dev environment:
|
||||
|
|
Loading…
Reference in New Issue