Skip to content

Commit

Permalink
modified the README.md files for other languages and fixed a linking …
Browse files Browse the repository at this point in the history
…issue at those files. (#3297)

* formatted docs/README.md for easy copy

* modified and fixed linking problem in various .md files
  • Loading branch information
Axwaizee committed Jan 28, 2024
1 parent 468c8aa commit cc98f13
Show file tree
Hide file tree
Showing 7 changed files with 132 additions and 26 deletions.
25 changes: 21 additions & 4 deletions docs/br/README_BR.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,16 +213,33 @@ Mas também dê uma olhada em:

### Executar Todos os Testes

Basta executar: `npm test`
Basta executar:

```bash
npm test
```

### Executar Testes para uma Versão Específica do Minecraft
Execute `npm test -- -g <versão>`, onde `<versão>` é uma versão do Minecraft, como `1.12`, `1.15.2`...

Execute

```bash
npm test -- -g <versão>
```

onde `<versão>` é uma versão do Minecraft, como `1.12`, `1.15.2`...

### Executar um Teste Específico
Execute `npm test -- -g <nome_do_teste>`, onde `<nome_do_teste>` é o nome do teste que você deseja executar, como `bed`, `useChests`, `rayTrace`...

Execute
```bash
npm test -- -g <nome_do_teste>
```

onde `<nome_do_teste>` é o nome do teste que você deseja executar, como `bed`, `useChests`, `rayTrace`...

## Licença

[MIT](LICENSE)
[MIT](../../LICENSE)

Esta documentação não é oficialmente mantida. Para ver as últimas atualizações, consulte a documentação original: [unstable_api](../README.md)
24 changes: 20 additions & 4 deletions docs/es/README_ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,17 +213,33 @@ Pero también echa un vistazo a:

### Ejecuta todas las pruebas

Simplemente ejecuta: `npm test`
Simplemente ejecuta:

```bash
npm test
```

### Ejecuta pruebas para una versión específica de Minecraft
Ejecuta `npm test -- -g <version>`, donde `<version>` es una versión de minecraft como `1.12`, `1.15.2`...

Ejecuta
```bash
npm test -- -g <version>
```

donde `<version>` es una versión de minecraft como `1.12`, `1.15.2`...

### Ejecuta una prueba específica
Ejecuta `npm test -- -g <test_name>`, donde `<test_name>` es el nombre de la prueba que quieres ejecutar como `bed`, `useChests`, `rayTrace`...

Ejecuta
```bash
npm test -- -g <test_name>
```

donde `<test_name>` es el nombre de la prueba que quieres ejecutar como `bed`, `useChests`, `rayTrace`...

## Licencia

[MIT](LICENSE)
[MIT](../../LICENSE)


Esta documentación no está mantenida oficialmente, si quiere ver las últimas novedades, por favor dirijase a la documentación original: [unstable_api](../README.md)
26 changes: 22 additions & 4 deletions docs/fr/README_FR.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,14 +221,32 @@ Laissez un coup d'oeil à ses projets :

### Tout tester

Exécuter seulement : `npm test`
Exécuter seulement :

```bash
npm test
```

### Tester une version spécifique
Exécutez `npm test -g <version>`, où `<version>` est une version de Minecraft comme `1.12`, `1.15.2`...

Exécutez

```bash
npm test -g <version>
```

`<version>` est une version de Minecraft comme `1.12`, `1.15.2`...

### Tester un test spécifique
Executer `npm test -g <test_name>`, où `<test_name>` est le nom d'un teste comme `lit`, `utiliseCoffre`, `rayTrace`...

Executer

```bash
npm test -g <test_name>
```

`<test_name>` est le nom d'un teste comme `lit`, `utiliseCoffre`, `rayTrace`...

## Licence

[MIT](LICENCE)
[MIT](../../LICENSE)
29 changes: 25 additions & 4 deletions docs/ru/README_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,17 +219,38 @@ Mineflayer поддерживает сторонние плагины. Любо

### Тестирование всего

Просто запустите: `npm test`
Просто запустите:

```bash
npm test
```

### Тестирование определённой версии
Запустите `npm run mocha_test -- -g <version>`, где `<version>` означает версию, таких как `1.12`, `1.15.2`...
Запустите

```bash
npm run mocha_test -- -g <version>
```

где `<version>` означает версию, таких как `1.12`, `1.15.2`...

### Тестирование определённой функции
Запустите `npm run mocha_test -- -g <test_name>`, где `<test_name>` означает название проверки, таких как `bed`, `useChests`, `rayTrace`...

Запустите

```bash
npm run mocha_test -- -g <test_name>
```

где `<test_name>` означает название проверки, таких как `bed`, `useChests`, `rayTrace`...

### Пример

`npm run mocha_test -- -g "1.18.1.*BlockFinder"` запустит тест BlockFinder на версии 1.18.1
```bash
npm run mocha_test -- -g "1.18.1.*BlockFinder"
```

запустит тест BlockFinder на версии 1.18.1

## Лицензия

Expand Down
23 changes: 19 additions & 4 deletions docs/tr/README_TR.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,13 +218,28 @@ En çok güncellenen ve en kullanışlı olan bazıları:

### Her şeyi test etme

Basitçe `npm test` komutunu çalıştırın
Basitçe
```bash
npm test
```

komutunu çalıştırın

### Özel bir sürümü test etme
`npm test -- -g <version>` komutunu çalıştırın, `<version>` bir Minecraft sürümü olmalı (`1.12`, `1.15.2` gibi).

```bash
npm test -- -g <version>
```

komutunu çalıştırın, `<version>` bir Minecraft sürümü olmalı (`1.12`, `1.15.2` gibi).

### Özel bir şeyi test etme
`npm test -- -g <test_name>` komutunu çalıştırın, `<test_name>` kısmının olduğu bölüm bir test adı olmalı (`bed`, `useChests`, `rayTrace` gibi).

```bash
npm test -- -g <test_name>
```

komutunu çalıştırın, `<test_name>` kısmının olduğu bölüm bir test adı olmalı (`bed`, `useChests`, `rayTrace` gibi).

## Lisans
[MIT](LICENSE)
[MIT](../../LICENSE)
2 changes: 1 addition & 1 deletion docs/zh/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,6 @@ docs/api.md 的内容是用doctoc制作的。更新该文件后,应运行 `doc

没有doctoc命令使用下面的命令安装

```
```bash
npm install -g doctoc
```
29 changes: 24 additions & 5 deletions docs/zh/README_ZH_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,20 +228,39 @@ mineflayer 支持插件;任何人都可以创建一个插件,在 mineflayer

### 完整测试

运行:`npm test`
运行
```bash
npm test
````

### 测试指定版本

运行 `npm mocha_test -- -g <version>`, 其中 `<version>` 表示 minecraft 版本号 如 `1.12`, `1.15.2`...
运行

```bash
npm mocha_test -- -g <version>
```

其中 `<version>` 表示 minecraft 版本号 如 `1.12`, `1.15.2`...

### 测试指定测试脚本

运行 `npm mocha_test -- -g <test_name>`,其中 `<test_name>` 是测试名称,例如 `bed`, `useChests`, `rayTrace`...
运行

```bash
npm mocha_test -- -g <test_name>
```

其中 `<test_name>` 是测试名称,例如 `bed`, `useChests`, `rayTrace`...

### 示例

`npm run mocha_test -- -g "1.18.1.*BlockFinder"` 进行 1.18.1 寻路测试
```bash
npm run mocha_test -- -g "1.18.1.*BlockFinder"
```

进行 1.18.1 寻路测试

## 许可证

[MIT](../LICENSE)
[MIT](../../LICENSE)

0 comments on commit cc98f13

Please sign in to comment.