diff --git a/README.md b/README.md index 528c218..4b51d95 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,35 @@ # k3GPT -# Git 仓库初始化与推送指南 - ## 1. Git账号、密码 - ```bash - Git 账号和密码信息请在“工程实践项目管理” - “我的项目”模块中的“我的信息”处查看。 - ``` - ## 2. 创建新的 Git 仓库并推送 - ```bash - # 创建项目目录并进入 - mkdir k3GPT - cd k3GPT - # 初始化本地 Git 仓库 - git init - # 创建一个 info 文件(可选) - touch info.md - # 将文件添加到暂存区 - git add info.md - # 提交到本地仓库 - git commit -m 'first commit' - # 创建本地分支admin - git branch admin - # 设置admin为当前分支 - git checkout admin - # 添加远程仓库地址(别名为 origin) - git remote add origin https://library.ithyxy.com/13315423919/k3GPT.git - # 先拉取远程admin分支的内容,并合并到本地 - git pull origin admin --allow-unrelated-histories - # 推送到远程仓库的 admin 分支,并设置上游跟踪 - git push -u origin 'admin' - ``` - ## 3. 已有仓库? - ```bash - cd existing_git_repo - git remote add origin https://library.ithyxy.com/13315423919/k3GPT.git - git push -u origin 'admin' - ``` \ No newline at end of file +#### 介绍 +k3GPT是一个大模型AI驱动的知识共享平台,通过知识搜索、知识对话、知识创作、知识广场等功能,实现知识从汇聚沉淀、加工创作,到流动共享的全过程管理,因此称为知识knowledge x 3的GPT平台, 名曰: k3GPT. + +#### 软件架构 +![架构图](doc/architecture.jpg) + +#### 安装教程 +详见《安装.txt》文档 + +#### 功能特点 + +1. 支持本地部署大模型,提供了llama.cpp和Qwen3-4B的安装包,更容易部署 +2. 支持windows共享、ftp、sftp等文件服务器,支持海量文件的聚合搜索 +3. 支持在线AI编辑创作知识百科、词条 +4. 支持使用云上的大模型API,减少大模型部署的成本 +5. 详见《k3gpt使用说明.docx》 + +#### 参与贡献 + +1. Fork 本仓库 +2. 新建 Feat_xxx 分支 +3. 提交代码 +4. 新建 Pull Request + +以上都可以,欢迎大家共创! + +#### 特别声明 +1. k3GPT项目开源采用MIT协议,可以用于商用,欢迎大家提出宝贵需求和建议,让项目发展的更好! +2. 感谢wangEditor项目,让开发AI编辑器更加容易! +3. QQ交流 : 3562910451 + + +