Merge branch 'add-apps-tutorial' into 'main'

Add tutorials on simple result viewer and dispatch checker

See merge request wotsubo/PSBoardDataBase!1411

docs/make.jl

@@ -26,6 +26,10 @@ makedocs(
     pages = [
         "Home" => "index.md",
         "Tutorial" => "tutorial.md",
+        "Apps" => [
+            "Simple result viewer" => "howtouse-simpleviewer.md",
+            "Dispatch checker" => "howtouse-dispatchchecker.md",
+        ],
         "Examples" => "examples.md",
         "About this software" => "about_software.md",
     ],

docs/src/howtouse-dispatchchecker.md

@@ -0,0 +1,55 @@
+# 出荷チェッカーの使い方
+
+このページではデータベースを活用した**出力チェッカー**の使い方を説明します。
+
+![出荷チェッカー仕様例](./assets/dispatch_checker_example.png)
+
+## 事前準備
+このアプリを使うには以下の3つが必要です。
+
+1. julia
+2. このgitリポジトリ
+3. データベースファイル
+
+### julia
+[簡易試験結果閲覧アプリの使い方](./howtouse-simpleviewer.md#julia)を参照してください。
+
+### このgitリポジトリ
+このページの右上から飛べます。
+
+### データベースファイル
+[Tutorial](./tutorial.md)にかかれています。
+このプロジェクト(git)のルートにおいてください。
+
+## 実行
+まずはjuliaを起動します。
+ターミナルでプロジェクトのルート(`Project.toml`がある場所)に移動して以下のオプションとともに`julia`を起動してください。
+```sh
+$ julia --project
+```
+
+!!! tip
+    `-t auto`とするとマルチスレッドで起動します。
+
+!!! tip
+    `using OhMyREPL`とするとREPLでシンタックスハイライトがつくようになります。
+
+次に、パッケージを読み込みます。
+```julia
+using PSBoardDataBase
+```
+
+そして、[`PSBoardDataBase.DispatchChecker.interactive_dispatch_checker`](@ref)をデータベースのパスを与えて実行します。
+```julia
+PSBoardDataBase.DispatchChecker.interactive_dispatch_checker("psboard_qaqc.db")
+```
+
+しばらくすると`PSBoard ID: `と表示されるので、出荷チェックを行いたいPSBoardのQRコードを読むと(もしくはPS00xxxxと手入力すると)、そのPSBoardの試験結果をとってきて、**出荷可能な場合は`Ok`と表示**されます。
+出荷可能でない場合は`No`と表示されます[^1]。
+出荷可能かわからない場合は試験結果がすべて表示されるので、それをみて判断します(yまたはnを入れてEnter)。
+
+[^1]: 現状表示されることはないです
+
+最後に"Finished"のあとにPSxxxxxxがプリントされるので、それをコピーしてスプレッドシートの出荷のところに書いてください[^2]。
+
+[^2]: もしくは返り値としてPSBoard IDの`Vector`が返ってくるのでそれを使ってください

docs/src/howtouse-simpleviewer.md

@@ -0,0 +1,80 @@
+# 簡易試験結果閲覧アプリの使い方
+
+このページでは以下の画像のように、**あるPSBoard IDに関連する試験結果を取得する簡易的なアプリ**の使い方を説明します。
+
+![結果閲覧アプリの起動時の様子](./assets/simple_result_viewer_front.png)
+
+## 事前準備
+このアプリを動かすには以下の3つが必要です。
+
+1. julia
+2. このgitリポジトリに含まれる`examples/get_results.jl`のファイル
+3. データベースファイル
+
+### julia
+Juliaはプログラミング言語です。
+[公式のダウンロードページ](https://julialang.org/downloads/)のはじめに書いてある通りにインストールするのが推奨されます。
+
+具体的には、
+
+- Windowsの場合
+    - ターミナルで`winget install julia --source msstore`(冒頭にあるコードです)
+- *nixの場合
+    - システムのパッケージマネージャを使う(例えばAUR)、または
+    - 公式のダウンロードページの冒頭にあるスニペットを実行する
+
+でダウンロードとインストールができます。
+ターミナルで`julia`と打って起動すればインストール完了です。
+
+!!! tip
+    ```jl
+    using OhMyREPL
+    ```
+    とするとシンタックスハイライトがつくようになって便利です。
+    パッケージをインストールするか聞かれるので、`y`を選びましょう。
+
+### `examples/get_results.jl`ファイル
+複数の入手方法があります。
+
+この閲覧アプリ以外を使う予定がまったくない場合は、`./assets/get_results.html`の右上にrun this notebookみたいなのがあるので、そこからたどるとファイルをダウンロードできます。
+以下で手に入れるデータベースファイルはこのファイルに対して一つ上のディレクトリに置かれることが想定されています(変更は容易です)。
+
+**おすすめの方法**はこのgitリポジトリごとダウンロードする方法です。
+`examples`ディレクトリの中に入っています。
+
+### データベース
+[Tutorial](./tutorial.md)にかかれています。
+
+## 実行
+まずは[Pluto](https://plutojl.org)をインストールします。
+juliaを起動して、`]`を押して[^1]
+```
+add Pluto
+```
+と入力してパッケージをインストールします。
+
+終わったら、BackSpaceを押して(左側が`julia>`になります)、
+```julia
+using Pluto
+Pluto.run()
+```
+と入力します。
+
+しばらくすると、ブラウザが立ち上がってPlutoが起動すると思います。
+"Open a notebook"から先程入手した`get_results.jl`ファイルを選び、開きます。
+
+右上に`Run notbook code`とあるので、クリックします。
+しばらくすると(かなり時間がかかると思います。右下の"Status"が全部緑になれば完了です)[^2]、"PSBoard idを入力"と書かれたテキストボックスが使えるようになるので、そこに検索したいPSBoardのIDを入力すれば下側にそれに関連する情報が表示されます。
+
+[^1]: Pkgモードというパッケージや環境の管理を行うモードになります。
+[^2]: この間に必要なパッケージをダウンロード・コンパイルしています。2回目以降は早くなります。
+
+## Tips
+
+!!! tip
+    juliaを起動するときに`julia -t auto`とオプションをつけると、マルチスレッドで起動します。
+    PCの性能次第では若干処理が早くなるかもしれません。
+
+!!! tip
+    ノートブック(アプリ)の下側にコードが書かれています。
+    中身はただのJuliaのコードなので、それらを編集すれば任意のコードが実行できます。

docs/src/index.md

@@ -8,7 +8,8 @@ Depth = 4
 ```
 
 !!! info
-    チュートリアルは[Tutorial](./tutorial.md)にあります。
+    - 簡易結果閲覧アプリの使い方は[Simple result viewer](./howtouse-simpleviewer.md)にあります。
+    - データベース本体の使い方に関するチュートリアルは[Tutorial](./tutorial.md)にあります。
 
 ## データベースの特徴