From 97f9b8a400ade39ac8d4fb993d8b23fb33be9461 Mon Sep 17 00:00:00 2001 From: aisuneko icecat Date: Sun, 8 Sep 2024 20:22:58 +0800 Subject: [PATCH] fix: minor issues in docs --- README.md | 1 + README_en.md | 3 ++- USAGE_en.md | 4 ++-- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b7621d9..ff95f93 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,5 @@ Lintestor 是一个基于 Rust 的软件包可用性自动化测试系统，支 ## 使用 参见 [USAGE.md](USAGE.md). + See [USAGE_en.md](USAGE_en.md) for English usage. \ No newline at end of file diff --git a/README_en.md b/README_en.md index 9cfd7d1..fafee1f 100644 --- a/README_en.md +++ b/README_en.md @@ -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 @@ -14,4 +14,5 @@ ## Usage See [USAGE_en.md](USAGE_en.md). + 中文使用说明参见 [USAGE.md](USAGE.md). \ No newline at end of file diff --git a/USAGE_en.md b/USAGE_en.md index ab11528..ea8a186 100644 --- a/USAGE_en.md +++ b/USAGE_en.md @@ -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. @@ -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