Skip to content

Commit

Permalink
docs: Modify i18n documents
Browse files Browse the repository at this point in the history
  • Loading branch information
fangyinc committed Mar 25, 2024
1 parent 8fa129d commit 5721e30
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 3 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,6 @@ At present, we have introduced several key features to showcase our current capa

## Contribution

- Please run `black .` before submitting the code.
- To check detailed guidelines for new contributions, please refer [how to contribute](https://github.com/eosphoros-ai/DB-GPT/blob/main/CONTRIBUTING.md)

### Contributors Wall
Expand Down
3 changes: 2 additions & 1 deletion README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,8 @@
- [数据Agents](https://www.yuque.com/eosphoros/dbgpt-docs/gwz4rayfuwz78fbq)

## 贡献
> 提交代码前请先执行 `black .`

更加详细的贡献指南请参考[如何贡献](https://github.com/eosphoros-ai/DB-GPT/blob/main/CONTRIBUTING.md)

这是一个用于数据库的复杂且创新的工具, 我们的项目也在紧急的开发当中, 会陆续发布一些新的feature。如在使用当中有任何具体问题, 优先在项目下提issue, 如有需要, 请联系如下微信,我会尽力提供帮助,同时也非常欢迎大家参与到项目建设中。

Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ services:
- dbgpt-myql-db:/var/lib/mysql
- ./docker/examples/my.cnf:/etc/my.cnf
- ./docker/examples/sqls:/docker-entrypoint-initdb.d
- ./assets/schema/knowledge_management.sql:/docker-entrypoint-initdb.d/knowledge_management.sql
- ./assets/schema/dbgpt.sql:/docker-entrypoint-initdb.d/dbgpt.sql
restart: unless-stopped
networks:
- dbgptnet
Expand Down
41 changes: 41 additions & 0 deletions i18n/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,47 @@ processing before submitting code. This not only helps keep our codebase's
internationalization up to date but also ensures a consistent experience for all users,
regardless of their language.

## Installation

Before you start, make sure you have the necessary tools installed:
- make
- gettext

Here are some ways to install `gettext`:

### Ubuntu/Debian And Derivatives

```bash
sudo apt update
sudo apt install gettext
````

### Fedora/CentOS/RHEL

- Fedora:
```bash
sudo dnf install gettext
```
- CentOS/RHEL:
```bash
# CentOS/RHEL 7 And Older
sudo yum install gettext
# CentOS/RHEL 8 And Newer
sudo dnf install gettext
```

### Arch Linux

```bash
sudo pacman -Sy gettext
```

### MacOS

```bash
brew install gettext
```

## Before You Submit

Please follow these steps to update and verify the project's internationalization files:
Expand Down
50 changes: 50 additions & 0 deletions i18n/README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,56 @@
为确保我们的项目在全球范围内保持高可用性和易于维护,每位开发者在提交代码之前都需要遵循以下国际化(i18n)
处理步骤。这不仅有助于保持我们代码库的国际化最新,也确保了所有用户不论使用何种语言都能获得一致的体验。

## 安装

### 对于Debian/Ubuntu及其衍生系统

打开终端,然后运行以下命令来安装gettext:

```bash
sudo apt update
sudo apt install gettext
```

### 对于Fedora、CentOS/RHEL

如果你使用的是Fedora、CentOS或RHEL系统,可以使用下面的命令安装gettext:

- 对于Fedora:
```bash
sudo dnf install gettext
```

- 对于CentOS/RHEL:
```bash
# CentOS/RHEL 7 和一些旧版本
sudo yum install gettext
# CentOS/RHEL 8 及更高版本
sudo dnf install gettext
```

### 对于Arch Linux

在Arch Linux及其衍生系统上,使用pacman包管理器安装gettext:

```bash
sudo pacman -Sy gettext
```

### 对于MacOS

如果你使用的是MacOS,可以通过Homebrew来安装gettext:

```bash
brew install gettext
```

### 安装完成后

安装完成后,你可以通过在终端运行`xgettext --version`来检查`xgettext`是否成功安装。

如果你依然遇到问题,可能需要检查你的PATH环境变量设置,确保gettext的安装目录已被添加到PATH中,或者尝试重新打开一个新的终端会话。

## 在提交前

请按照以下步骤更新和验证项目的国际化文件:
Expand Down

0 comments on commit 5721e30

Please sign in to comment.