Skip to content

Commit

Permalink
added help to README
Browse files Browse the repository at this point in the history
fedevilensky committed Oct 19, 2022
1 parent afc9725 commit 20cd9d7
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Readme.md → README.md
Original file line number Diff line number Diff line change
@@ -15,16 +15,17 @@ go install github.com/fedevilensky/go-scaffold@latest
```

## Usage
`go-scaffold <folder-name>` to create a new module in a new folder named `<folder-name>`, or just `go-scaffold` to create project in pwd
`go-scaffold h` or `go-scaffold help` to display the help message.

`go-scaffold <folder-name>` to create a new module in a new folder named `<folder-name>`, or just `go-scaffold` to create project in pwd.

Use arrows (or `j` and `k`) to navigate, space to select, `q` to quit and enter to continue. When a text prompt is present you can still quit with `Ctrl+c`

Every file and folder will be created at the end, so feel free to quit and start over


## Known problems
Will panic if go mod already exists


----------
Logo created with [Gopher Konstructor](https://github.com/quasilyte/gopherkon), based on Renee French's design
Logo created with [Gopher Konstructor](https://github.com/quasilyte/gopherkon), based on Renee French's design

0 comments on commit 20cd9d7

Please sign in to comment.