Skip to content

Commit 5655ac0

Browse files
authored
Merge pull request #1 from arduino/AlessandroSanino1994-added-readme
README creation
2 parents 394dce7 + 614462a commit 5655ac0

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.adoc

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
= arduino-cli
2+
3+
Arduino CLI is a tool to access all Arduino Create API from Command Line.
4+
It implements all functions provided by web version of Arduino Create.
5+
6+
== Installation
7+
. `git clone` this repository into a folder of your choice
8+
. Add '/path/to/arduino/cli/folder' to your PATH environment variable
9+
. Reload shell configuration or reboot
10+
And you're done, now let's see how to use the CLI.
11+
12+
== Usage
13+
14+
A general call is `arduino [COMMAND] [options]`
15+
To see the full list of commands, call `arduino -h` or `arduino --help`
16+
17+
== Contribution
18+
19+
To contribute to this project:
20+
21+
. `git clone` this repository
22+
. Create a new branch with the name `feature-to-implement` or `bug-to-fix`
23+
. Code your contribution and push to your branch
24+
. Ask a Pull Request

0 commit comments

Comments
 (0)