diff --git a/README.md b/README.md index 828d003..e168593 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ WIP +For Japanese: [./docs/README-ja.md](README-ja.md) + ## For developers +Use `rustup` to set up developing tools. + ### build / run ```sh cargo build @@ -13,6 +17,7 @@ Build for JATHub using cross: ```sh CROSS_CONTAINER_ENGINE=podman cross build --release --target armv7-unknown-linux-musleabihf ``` +`CROSS_CONTAINER_ENGINE=podman` is optional(default docker). ### test ```sh diff --git a/docs/README-ja.md b/docs/README-ja.md new file mode 100644 index 0000000..88e30ea --- /dev/null +++ b/docs/README-ja.md @@ -0,0 +1,22 @@ +# psb_qaqc +日本語ドキュメント(WIP) + +## 機能 +サブコマンドごとに機能がわかれている。 +各コマンドで`--help`を渡せばドキュメントがみれる。 + +### `add-master-log` +QAQC実施直後にMaster JATHub上で実行することでMasterでのログをCSVに書き加える。 + +```sh +psb-qaqc add-master-log ./logs/20240722_180104.log out.csv +``` + +### `check-db` (WIP) +CSVファイルのフォーマットが正常か確認する。 +正常でない場合、返り値は0以外を返す。 + +```sh +psb-qaqc check-db out.csv +``` +