mirror of
https://gitlab.cern.ch/wotsubo/psboard-qaqc-postprocess.git
synced 2024-11-24 08:01:11 +09:00
update: docs, add ja doc
This commit is contained in:
parent
059283fab3
commit
c996e5bd28
2 changed files with 27 additions and 0 deletions
|
@ -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
22
docs/README-ja.md
Normal 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
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue