forked from hybridgroup/gobot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tools: Add some improved docs to Gobot CLI
Signed-off-by: deadprogram <[email protected]>
- Loading branch information
1 parent
f539684
commit f12e9b1
Showing
3 changed files
with
48 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Gobot CLI | ||
|
||
Gobot has its own CLI to generate new platforms, adaptors, and drivers. | ||
|
||
## Building the CLI | ||
|
||
``` | ||
go build -o /path/to/dest/gobot . | ||
``` | ||
|
||
## Running the CLI | ||
|
||
``` | ||
/path/to/dest/gobot help | ||
``` | ||
|
||
Should display help for the Gobot CLI: | ||
|
||
``` | ||
CLI tool for generating new Gobot projects. | ||
NAME: | ||
gobot - Command Line Utility for generating new Gobot adaptors, drivers, and platforms | ||
USAGE: | ||
gobot [global options] command [command options] [arguments...] | ||
VERSION: | ||
0.12.1 | ||
COMMANDS: | ||
generate Generate new Gobot adaptors, drivers, and platforms | ||
help, h Shows a list of commands or help for one command | ||
GLOBAL OPTIONS: | ||
--help, -h show help | ||
--version, -v print the version | ||
``` | ||
|
||
## License | ||
Copyright (c) 2013-2016 The Hybrid Group. Licensed under the Apache 2.0 license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters