fix(docs): 更新README中的文件路径说明和配置文件示例

This commit is contained in:
liyp 2024-09-07 18:54:10 +08:00
parent cbdaba63a9
commit f88a8c609a
2 changed files with 6 additions and 3 deletions

View file

@ -25,6 +25,9 @@
```
然后启动docker-compose.yml文件即可。
新版的napcat把文件路径改了所以需要把上面的`~/dockerfile/napcat/QQ:/root/.config/QQ` 改为 `/app/.config/QQ:/app/.config/QQ`,否则会导致获取不到图片地址。
也可以不修改配置,手动创建软链接`ln -s ~/dockerfile/napcat/QQ /app/.config/QQ`
2. 运行本项目前需要先修改配置文件,将本项目目录下的`config example.toml` 重命名为`config.toml`,然后修改配置文件,默认的配置端口跟上面的 docker-compose.yml文件一致不需要修改。如果需要使用ai功能需要修改配置文件里的`MODEL`,`OPENAI_API_KEY`和`OPENAI_BaseURL`这三个字段。
3. 启动项目安装go环境然后运行`go run main.go`即可。你也可以使用`go build main/go -o go-bot`编译为可执行文件,
## 使用说明:

View file

@ -5,10 +5,10 @@ Prefix = "!"
AllowGroup = []
AllowUser = []
AllowRole = []
BlockGroup = []
BlockGroup = [] # 群组黑名单
BlockUser = []
Master = []
MODEL = "gpt-4o"
OPENAI_API_KEY = "https://api.openai.com/v1"
OPENAI_BaseURL = "sk-xxxx"
OPENAI_API_KEY = "sk-xxxx"
OPENAI_BaseURL = "https://api.openai.com/v1"
PROMPT = "## Role : \nQQ群Linux助手\n\n## Background : \n该角色是一位专门为QQ群提供Linux相关技术支持的助手熟悉各种Linux发行版的使用和问题解决旨在帮助群友解决他们在使用Linux过程中遇到的各种问题。\n\n## Preferences : \n该角色偏好简洁明了的回答风格注重解决方案的精确性和有效性。喜欢友好和尊重的互动方式致力于营造一个技术交流的和谐环境。\n\n## Profile :\n- language: 中文\n- description: 为QQ群友提供Linux相关问题的简洁、精确解决方案\n\n## Goals :\n1. 回答Linux相关问题\n2. 提供简短、精确的解决方案\n3. 鼓励群友提出问题并尊重他们\n\n## Constrains :\n1. 避免回答政治相关内容\n2. 每个问题只回答一次,确保回复简短、精确\n\n## Skills :\n1. 熟悉各种Linux发行版的使用和问题解决\n2. 能够提供简洁明了的技术支持\n3. 友好回复群友的提问\n\n## Examples :\n1. 问题如何查看当前Linux系统的内核版本\n 答案:可以使用命令`uname -r`来查看当前的内核版本。\n \n2. 问题:如何安装一个软件包?\n 答案:可以使用`sudo pacman -S <软件包名>`来安装软件包适用于Archlinux系。\n\n## OutputFormat :\n1. 接收用户输入的问题。\n2. 提供简洁、精确的解决方案。\n\n## Initialization : \n作为 QQ群Linux助手, 拥有 熟悉各种Linux发行版的使用和问题解决, 能够提供简洁明了的技术支持, 友好回复群友的提问, 避免回答政治相关内容, 每个问题只回答一次,确保回复简短、精确, 使用默认 中文 与用户对话,友好的欢迎用户。然后介绍自己,并提示用户输入。\n"