package template

import "fmt"

func Readme() string { return fmt.Sprintf("#### 1. 使用说明\n\n\n- golang版本 >= v1.16\n- 本项目是一个基于golang的web项目，使用了gin框架、gorm框架、jwt框架、swaggo框架、antgo框架等，实现了一个简单的web项目,如果有问题请联系作者邮箱：[email protected]\n- IDE推荐：Goland\n\n\n#### 1.1 接口文档生成\n\n\n- 接口文档生成工具：swaggo/swag\n- 安装：go install github.com/swaggo/swag/cmd/swag@latest\n- 生成接口文档：swag init --parseDependency --parseInternal\n- 访问接口文档：http://localhost:9001/swagger/index.html\n\n\n#### 1.2 ant-cli 使用说明\n\n\n- 框架Cli工具：ant-cli\n- 安装：go install github.com/small-ek/ant-cli@latest\n- 帮助文档：ant-cli h\n- RSA生成：ant-cli rsa\n- 创建项目:ant-cli create demo\n- 生成接口相关内容,请先设置配置文件,生成后需要执行:ant-cli install\n- 命令根据表生成接口：ant-cli gen api database.table\n- 命令根据表生成模型：ant-cli gen model database.table\n- 命令根据表生成Dao：ant-cli gen dao database.table\n- 前端接口生成,可以生成关联模型相关：ant-cli ui\n- CLI编译：ant-cli build main.exe\n- CLI运行：ant-cli run main.go\n- 包项目安装：ant-cli install\n- 访问地址：http://127.0.0.1:49000\n\n\n#### 1.3 go mod 使用说明\n\n\n- 依赖管理工具：go mod\n- 初始化：go mod init\n- 整理和更新项目的依赖关系：go mod tidy\n- 依赖的模块复制到项目：go mod vendor\n\n\n#### 1.3 go run 使用说明\n\n\n- 命令用于编译并运行Go程序工具：go run\n- 初始化：go run main.go\n- 运行项目：go run main.go\n\n\n#### 1.3 go build 使用说明\n\n\n- 命令用于编译Go程序工具：go build\n- 编译：go build -o main.exe -ldflags \"-s -w\"\n- 运行：./main.exe\n- linux交叉编译：\ngo env -w GOOS=linux\ngo env -w GOARCH=amd64\ngo build -o main-linux -ldflags \"-s -w\"\n- mac交叉编译：\ngo env -w GOOS=darwin\ngo env -w GOARCH=amd64\ngo build -o main-macos -ldflags \"-s -w\"\n- windows交叉编译：\ngo env -w GOOS=windows\ngo env -w GOARCH=amd64\ngo build -o main.exe -ldflags \"-s -w\"\n") }