research/psboard-qaqc-postprocess
1
0
Fork 0
mirror of https://gitlab.cern.ch/wotsubo/psboard-qaqc-postprocess.git synced 2025-07-01 17:19:29 +09:00
Code Issues Projects Releases Packages Wiki Activity Actions

update: docs, add ja doc

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

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