From b942c67d8e508fba5f62fa0b9183618dbe5e9bcf Mon Sep 17 00:00:00 2001 From: Foil-hat-guy Date: Tue, 22 Apr 2025 19:27:36 +0300 Subject: [PATCH] README.md finalized. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f86c7e3..c38dcae 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,14 @@ import ( ``` 3. In the main package add a go:generate directive: ```go -//go:generate go run code.foilhatguy.casa/pub/help +//go:generate go run code.foilhatguy.casa/pub/help HELP.md ``` +The last part in this directive is a name of 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 ./...