update: docs, add ja doc

This commit is contained in:
Wataru Otsubo 2024-07-24 12:48:41 +09:00
parent 059283fab3
commit c996e5bd28
2 changed files with 27 additions and 0 deletions

View file

@ -2,7 +2,11 @@
WIP WIP
For Japanese: [./docs/README-ja.md](README-ja.md)
## For developers ## For developers
Use `rustup` to set up developing tools.
### build / run ### build / run
```sh ```sh
cargo build cargo build
@ -13,6 +17,7 @@ Build for JATHub using cross:
```sh ```sh
CROSS_CONTAINER_ENGINE=podman cross build --release --target armv7-unknown-linux-musleabihf CROSS_CONTAINER_ENGINE=podman cross build --release --target armv7-unknown-linux-musleabihf
``` ```
`CROSS_CONTAINER_ENGINE=podman` is optional(default docker).
### test ### test
```sh ```sh

22
docs/README-ja.md Normal file
View file

@ -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
```