Skip to content

Commit 0110552

Browse files
committed
updated README
1 parent 2849f79 commit 0110552

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

README.adoc

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,48 @@ It implements all functions provided by web version of Arduino Create.
1010
. `git clone` this repository into a folder of your choice
1111
. Add '/path/to/arduino-cli/folder' to your PATH environment variable
1212
. Reload shell configuration or reboot
13-
And you're done, now let's see how to use the CLI.
13+
14+
15+
== Compiling
16+
you have two ways:
17+
18+
.> By running the go main file.
19+
[source, bash]
20+
----
21+
$ go run main.go ARGS
22+
----
23+
24+
.> By compiling then running the go program.
25+
[source, bash]
26+
----
27+
$ go build -o arduino
28+
$ ./arduino ARGS
29+
----
30+
31+
If you want autocompletion and manpages you have to compile and execute (second way)
32+
33+
And you're done, now let's see how to use the CLI.
1434

1535
== Usage : An example
1636

17-
A general call is `arduino [COMMAND] [options]`
18-
To see the full list of commands, call `arduino help [COMMAND]`, arduino [COMMAND] -h` or `arduino [COMMAND] --help`
37+
A general call is
38+
[source, bash]
39+
----
40+
$ arduino [COMMAND] [options]
41+
----
42+
43+
To see the full list of commands, call one of the following:
44+
[source, bash]
45+
----
46+
$ arduino help [COMMAND]
47+
$ arduino [COMMAND] -h
48+
$ arduino [COMMAND] --help
49+
----
1950

20-
output from help command:
51+
Here is the output from help command `arduino help`:
2152
[source, bash]
2253
----
54+
$ arduino help
2355
Arduino Create Command Line Interface (arduino-cli)
2456
2557
Usage:
@@ -42,7 +74,7 @@ Flags:
4274
Use "arduino [command] --help" for more information about a command.
4375
----
4476

45-
== Contribution
77+
== Contributing
4678

4779
To contribute to this project:
4880

0 commit comments

Comments
 (0)