Skip to content

Commit 9a1668e

Browse files
BinaryHuskPlucky923
authored andcommitted
docs: fix misleading CLI usage examples in README
1 parent 8866565 commit 9a1668e

File tree

2 files changed

+4
-8
lines changed

2 files changed

+4
-8
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,12 @@ The CLI mirrors the classic `cstool` UX. For example, to decode a RISC-V instruc
4343
make run -- riscv32 13000513 -d
4444
```
4545

46-
The command also accepts arguments without the explicit `--` separator:
46+
Alternatively, use the `RUN_ARGS` variable. This prevents `make` from misinterpreting flags like `-d`:
4747

4848
```bash
49-
make run riscv32 13000513 -d
49+
make run RUN_ARGS="riscv32 13000513 -d"
5050
```
5151

52-
Internally the target forwards any trailing words to the binary (or you can pass them via `RUN_ARGS="..."`).
53-
5452
## Testing
5553

5654
Run the full regression suite from the repository root:

README_CN.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,12 @@ CLI 镜像了经典的 `cstool` 用户体验。例如,要解码 RISC-V 指令
4444
make run -- riscv32 13000513 -d
4545
```
4646

47-
该命令也接受不带显式 `--` 分隔符的参数
47+
或者,您可以使用 `RUN_ARGS` 变量。这样可以防止 `make` 错误解析 `-d` 等标志
4848

4949
```bash
50-
make run riscv32 13000513 -d
50+
make run RUN_ARGS="riscv32 13000513 -d"
5151
```
5252

53-
在内部,目标会将任何尾随单词转发给二进制文件(或者您可以通过 `RUN_ARGS="..."` 传递它们)。
54-
5553
## 测试
5654

5755
从仓库根目录运行完整的回归测试套件:

0 commit comments

Comments
 (0)