|
| 1 | +# arduino-cli |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +Arduino CLI is an all-in-one solution that provides builder, boards/library manager, |
| 6 | +uploader, discovery and many other tools needed to use any Arduino compatible |
| 7 | +board and platforms. |
| 8 | + |
| 9 | +[![tests-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=test) |
| 10 | +[![nightly-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=nightly) |
| 11 | +[![codecov-badge]](https://codecov.io/gh/arduino/arduino-cli) |
| 12 | + |
| 13 | +> **Note:** this software is currently under active development: anything can change |
| 14 | + at any time, API and UI must be considered unstable until we release version 1.0.0. |
| 15 | + |
| 16 | +## Docs |
| 17 | + |
| 18 | +For guidance on installation and development, see the [User documentation]. |
| 19 | + |
| 20 | +## Quickstart |
| 21 | + |
| 22 | +1. [Install] the Arduino CLI |
| 23 | +2. Follow the [Getting Started] guide to check out what the CLI can do |
| 24 | +3. Browse the [Commands reference] to see all the available commands |
| 25 | +4. Should you have an issue, read the [FAQ] page |
| 26 | + |
| 27 | +## How to contribute |
| 28 | + |
| 29 | +Contributions are welcome! |
| 30 | + |
| 31 | +Please read the document [How to contribute] which will show you how to build |
| 32 | +the source code, run the tests, and contribute your changes to the project. |
| 33 | + |
| 34 | +:sparkles: Thanks to all our [contributors]! :sparkles: |
| 35 | + |
| 36 | + |
| 37 | +[tests-badge]: https://github.com/Arduino/arduino-cli/workflows/test/badge.svg |
| 38 | +[nightly-badge]: https://github.com/Arduino/arduino-cli/workflows/nightly/badge.svg |
| 39 | +[codecov-badge]: https://codecov.io/gh/arduino/arduino-cli/branch/master/graph/badge.svg |
| 40 | +[User documentation]: https://arduino.github.io/arduino-cli/ |
| 41 | +[Getting Started]: https://arduino.github.io/arduino-cli/getting-started/ |
| 42 | +[Commands reference]: https://arduino.github.io/arduino-cli/commands/ |
| 43 | +[FAQ]: https://arduino.github.io/arduino-cli/FAQ/ |
| 44 | +[How to contribute]: https://arduino.github.io/arduino-cli/CONTRIBUTING/ |
| 45 | +[contributors]: https://github.com/arduino/arduino-cli/graphs/contributors |
0 commit comments