vinchent/cobra
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Generator Docs to reflect changes brought in #817 (#904)

Browse Source
This commit is contained in:
Joshua Harshman 2019-07-24 10:10:51 -06:00 committed by GitHub
parent 2d7544ebde
commit 1c9c46d5c1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
cobra/README.md
View File

@ -16,11 +16,23 @@ for you. It is a very powerful application that will populate your program with
the right structure so you can immediately enjoy all the benefits of Cobra. It
will also automatically apply the license you specify to your application.
Cobra init is pretty smart. You can provide it a full path, or simply a path
similar to what is expected in the import.
Cobra init is pretty smart. You can either run it in your current application directory
or you can specify a relative path to an existing project. If the directory does not exist, it will be created for you.
Updates to the Cobra generator have now decoupled it from the GOPATH.
As such `--pkg-name` is required.
**Note:** init will no longer fail on non-empty directories.
```
cobra init github.com/spf13/newApp
mkdir -p newApp && cd newApp
cobra init --pkg-name github.com/spf13/newApp
```
or
```
cobra init --pkg-name github.com/spf13/newApp path/to/newApp
```
### cobra add