diff --git a/README.md b/README.md index c38dcae..7134948 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,13 @@ import ( ```go //go:generate go run code.foilhatguy.casa/pub/help HELP.md ``` -The last part in this directive is a name of help file for +The last part in this directive is a name of the help file for your application. It should be placed in the root directory of your project along with **main.go** file. The help file can be written ether in the MarkDown format, or in plain text. MarkDown will be automatically converted in to plain text, which is suitable for the console output. + 4. Run code generator by **go generate** command: ```shell go generate ./...