Skip to content

Commit

Permalink
fix: minor issues in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aisuneko committed Sep 8, 2024
1 parent 8381c43 commit 97f9b8a
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ Lintestor 是一个基于 Rust 的软件包可用性自动化测试系统,支
## 使用

参见 [USAGE.md](USAGE.md).

See [USAGE_en.md](USAGE_en.md) for English usage.
3 changes: 2 additions & 1 deletion README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[Docs](https://255doesnotexist.github.io/lintestor/) | [Release](about:blank) | [Summary](https://github.com/255doesnotexist/lintestor/blob/main/summary.md) | [Chinese README](README.md)

`lintestor` is a framework for automated software package availability testing, tailored for RISC-V platforms, with (theoritical) multi-distribution support.
`lintestor` is a framework for automated software package availability testing, tailored for RISC-V platforms, with (theoretical) multi-distribution support.

## Features

Expand All @@ -14,4 +14,5 @@
## Usage

See [USAGE_en.md](USAGE_en.md).

中文使用说明参见 [USAGE.md](USAGE.md).
4 changes: 2 additions & 2 deletions USAGE_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ port = 2222
username = "root"
password = "root"
```
Each subdirectory corresponding to a package should contain at least one test script (multiple scripts would be treated as multiple test cases). For writing the respective test scripts, Refer to existing ones under the `debian` folder to get you started.
Each subdirectory corresponding to a package should contain at least one test script (multiple scripts would be treated as multiple test cases). For writing the respective test scripts, refer to existing ones under the `debian` folder to get you started.

If certain commands need to be run globally prior each test script (eg. `export DEBIAN_FRONTEND=noninteractive` may be used on Debian-based systems to prevent apt interactive prompts), put them in `prerequisite.sh` under the distro directory.

Expand All @@ -37,7 +37,7 @@ cargo run -- --test --aggr --summ

A `report.json` report would be generated for each package under their respective subfolders. Now that the tests are done, check out the aggregated `reports.json` and the Markdown result matrix `summary.md` in the current directory.

To toggle logging levels, set the `RUST_LOGS` environment variable to one of the following: debug, warn, info, error. `info` is the default logging level.
To toggle logging levels, set the `RUST_LOG` environment variable to one of the following: debug, warn, info, error. `info` is the default logging level.
## Full CLI parameters

```sh
Expand Down

0 comments on commit 97f9b8a

Please sign in to comment.