diff --git a/README.md b/README.md index d9706bb8dd442f594304c098bea5e6ee3f131e68..664c652fe1589372cf782a2b4a4b87485fd43193 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,30 @@ -# Gitee AI 文档 - -### 安装依赖 - -``` -$ yarn -``` -### 添加 env 文件 -``` -$ cp .env.example .env -``` - -### 开发 - -``` -$ yarn start -``` +# Gitee AI 文档 -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +## 安装依赖 +请确保您已安装以下依赖项: +- Node.js +- Yarn -### 构建 +## 添加 env 文件 +在项目根目录下创建 `.env` 文件,并添加相应的环境变量。 +## 开发 +开发环境可以通过以下命令启动: +```bash +yarn serve ``` -$ yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### 部署到 Gitee Pages -Using SSH: - -``` -$ USE_SSH=true yarn deploy +## 构建 +要构建生产版本,请运行: +```bash +yarn build ``` -Not using SSH: +## 部署到 Gitee Pages +您可以使用 Gitee Pages 功能部署您的文档或应用。确保在 Gitee 仓库设置中配置了正确的分支和目录。 -``` -$ GIT_USER= yarn deploy -``` +有关更多细节和指南,请查阅 [Gitee Pages 文档](https://pages.gitee.com/)。 -If you are using Gitee pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +如需了解更多信息,请访问 [Gitee AI 官方网站](https://ai.gitee.com)。 \ No newline at end of file