From c996e5bd289f069a7399b9a9ba92d090d1098a7c Mon Sep 17 00:00:00 2001
From: Wataru Otsubo <wotsubo@icepp.s.u-tokyo.ac.jp>
Date: Wed, 24 Jul 2024 12:48:41 +0900
Subject: [PATCH] update: docs, add ja doc

---
 README.md         |  5 +++++
 docs/README-ja.md | 22 ++++++++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 docs/README-ja.md

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