pub/help
1
Fork 0
Code Issues Pull requests Releases Wiki Activity

README.md finalized.

Browse source
This commit is contained in:
Foil-hat-guy 2025-04-22 19:27:36 +03:00
parent 4a628ccc7e
commit b942c67d8e
No known key found for this signature in database
GPG key ID: 221CC305A7B23591
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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 ./...