Skip to content

Commit 2cfa970

Browse files
committed
Rename CLI usage to papyrus-compiler in READMEs
Update command examples in README.md and README.RU.md to use the correct executable name `papyrus-compiler` instead of `papyrus` across compile, read and create-dump examples so documentation matches the actual CLI.
1 parent 5498a49 commit 2cfa970

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

README.RU.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
3. Используйте следующий синтаксис для работы с компилятором:
3030

3131
```
32-
papyrus <command> [arguments]
32+
papyrus-compiler <command> [arguments]
3333
```
3434

3535
### Команды:
@@ -58,30 +58,30 @@ papyrus <command> [arguments]
5858

5959
#### Компиляция всех скриптов в директории с игнорированием кэша:
6060
```bash
61-
papyrus compile -nocache -i "D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source" -o "../test-files/compiled/skyrimSources"
61+
papyrus-compiler compile -nocache -i "D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source" -o "../test-files/compiled/skyrimSources"
6262
```
6363
Эта команда компилирует все скрипты (кэш игнорируется), расположенные в `D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source`, и помещает скомпилированные `.pex` файлы в каталог `../test-files/compiled/skyrimSources`.
6464

6565
#### Компиляция всех скриптов в директории:
6666
```bash
67-
papyrus compile -i "../../RH-workspace/scripts" -o "../../RH-workspace/compiled"
67+
papyrus-compiler compile -i "../../RH-workspace/scripts" -o "../../RH-workspace/compiled"
6868
```
6969
Эта команда компилирует все скрипты, расположенные в `../../RH-workspace/scripts`, и помещает скомпилированные `.pex` файлы в каталог `../../RH-workspace/compiled`.
7070

7171
#### Компиляция скриптов с использованием файлов заголовков/импортов:
7272
```bash
73-
papyrus compile -nocache -h "D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source" -i "../test-files/compiler" -o "../test-files/compiled"
73+
papyrus-compiler compile -nocache -h "D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source" -i "../test-files/compiler" -o "../test-files/compiled"
7474
```
7575
Эта команда скомпилирует все скрипты из каталога `../test-files/compiler` в каталог `../test-files/compiled`, а недостающая информация об объектах (`Form`, `ObjectReference`, `Actor` и т.д.) будет взята из `.psc` файлов в каталоге `D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source`.
7676

7777
#### Чтение скомпилированного `.pex` файла:
7878
```bash
79-
papyrus read "../test-files/compiled/ABCD.pex"
79+
papyrus-compiler read "../test-files/compiled/ABCD.pex"
8080
```
8181

8282
#### Создание JSON-дампа `.pex` файлов:
8383
```bash
84-
papyrus create-dump "../folder_with_pex_files"
84+
papyrus-compiler create-dump "../folder_with_pex_files"
8585
```
8686
Создает JSON-файл `dump.json`, содержащий некоторую информацию обо всех `.pex` файлах, расположенных в каталоге `../folder_with_pex_files`. Вот как это будет выглядеть:
8787
```json

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The compiler was created for the following purposes:
2929
3. Use the following syntax to work with the compiler:
3030

3131
```
32-
papyrus <command> [arguments]
32+
papyrus-compiler <command> [arguments]
3333
```
3434

3535
### Commands:
@@ -57,30 +57,30 @@ Below are several examples demonstrating the use of various compiler commands an
5757

5858
#### Compile all scripts in a directory, ignoring the cache:
5959
```bash
60-
papyrus compile -nocache -i "D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source" -o "../test-files/compiled/skyrimSources"
60+
papyrus-compiler compile -nocache -i "D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source" -o "../test-files/compiled/skyrimSources"
6161
```
6262
This command compiles all scripts (ignoring the cache) located in `D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source` and places the compiled `.pex` files in the `../test-files/compiled/skyrimSources` directory.
6363

6464
#### Compile all scripts in a directory:
6565
```bash
66-
papyrus compile -i "../../RH-workspace/scripts" -o "../../RH-workspace/compiled"
66+
papyrus-compiler compile -i "../../RH-workspace/scripts" -o "../../RH-workspace/compiled"
6767
```
6868
This command compiles all scripts located in `../../RH-workspace/scripts` and places the compiled `.pex` files in the `../../RH-workspace/compiled` directory.
6969

7070
#### Compile scripts using header/import files:
7171
```bash
72-
papyrus compile -nocache -h "D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source" -i "../test-files/compiler" -o "../test-files/compiled"
72+
papyrus-compiler compile -nocache -h "D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source" -i "../test-files/compiler" -o "../test-files/compiled"
7373
```
7474
This command will compile all scripts from the `../test-files/compiler` directory to the `../test-files/compiled` directory, and missing information about objects (`Form`, `ObjectReference`, `Actor`, etc.) will be taken from `.psc` files in the `D:\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source` directory.
7575

7676
#### Reading a compiled `.pex` file:
7777
```bash
78-
papyrus read "../test-files/compiled/ABCD.pex"
78+
papyrus-compiler read "../test-files/compiled/ABCD.pex"
7979
```
8080

8181
#### Creating a JSON dump of `.pex` files:
8282
```bash
83-
papyrus create-dump "../folder_with_pex_files"
83+
papyrus-compiler create-dump "../folder_with_pex_files"
8484
```
8585
Creates a JSON file `dump.json` containing some information about all `.pex` files located in the `../folder_with_pex_files` directory. Here's what it will look like:
8686
```json

0 commit comments

Comments
 (0)