Skip to content

Commit 2849f79

Browse files
committed
updated README
1 parent 07ce454 commit 2849f79

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

README.adoc

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,36 @@ It implements all functions provided by web version of Arduino Create.
1717
A general call is `arduino [COMMAND] [options]`
1818
To see the full list of commands, call `arduino help [COMMAND]`, arduino [COMMAND] -h` or `arduino [COMMAND] --help`
1919

20+
output from help command:
21+
[source, bash]
22+
----
23+
Arduino Create Command Line Interface (arduino-cli)
24+
25+
Usage:
26+
arduino [flags]
27+
arduino [command]
28+
29+
Available Commands:
30+
core Arduino Core operations
31+
help Help about any command
32+
lib Arduino commands about libraries
33+
version Shows version Number of arduino
34+
35+
Flags:
36+
--config string config file (default is $HOME/.arduino.yaml)
37+
--format string the output format, can be [text|json] (default "text")
38+
--generate-docs generates the docs for the CLI and puts it in docs folder
39+
-h, --help help for arduino
40+
-v, --verbose count[=-1] enables verbose output (use more times for a higher level)
41+
42+
Use "arduino [command] --help" for more information about a command.
43+
----
44+
2045
== Contribution
2146

2247
To contribute to this project:
2348

24-
. `git clone` this repository
25-
. Create a new branch with the name `feature-to-implement` or `bug-to-fix`
26-
. Code your contribution and push to your branch
27-
. Ask a Pull Request
49+
. `git clone` this repository.
50+
. Create a new branch with the name `feature-to-implement` or `bug-to-fix`.
51+
. Code your contribution and push to your branch.
52+
. Make a PR (Pull Request).

0 commit comments

Comments
 (0)