クイックスタートガイド(機能紹介)を作成した

manual/quick-start-guide.md

@@ -0,0 +1,59 @@
+# クイックスタートガイド
+
+このクイックスタートガイドでは本システムの機能と使い方を紹介します。
+
+## 1. 入退室ログの記録
+
+研究室への出入り時、カードリーダーに本学の学生証や職員証をタッチすることで入室時刻または退室時刻がデータベースに記録されます。
+
+### 実際の流れ
+
+1. カードリーダーに学生証か職員証をタッチする。
+2. 効果音に続いて挨拶の音声が流れる。
+
+:warning: 交通系ICカードや免許証などのカードをタッチすると警告音が鳴ります。本システムは本学の学生証または職員証にしか対応しておりませんので、必ずそれらを使用するようにしてください。
+
+## 2. ユーザーインタフェース
+
+本システムは入退室ログ等を閲覧するためのブラウザベースのインタフェースを備えています。
+
+### ユーザーインタフェースへのアクセス方法
+
+- ラズパイにディスプレイやキーボードを接続して使う場合
+  1. ラズパイで画面左上の:earth_americas:マークをクリックしブラウザを起動します。
+  2. `localhost:3001`にアクセスします。
+- ラズパイにディスプレイを接続せずに使う場合
+  1. ラズパイと同じネットワーク(学内LANならWRL-SUCCES-S3)に接続した任意のPCでブラウザを起動します。
+  2. `<ラズパイのIP>:3001`にアクセスします。
+
+### 現在の在室状況
+
+ラズパイ、別PCのいずれの場合でもアクセスするとこの画面になります。
+
+![index](img/ams-index.png)
+
+現在、研究室にいる人の学籍番号がリアルタイムに確認できます。
+
+### 入退室ログの表示
+
+画面左の **[ 入退室ログの表示 ]** をクリックします。このような画面になります。
+
+![log](img/ams-log.png)
+
+#### 入退室ログをCSVでダウンロード
+
+画面上部分では、現在までの入退室ログ(学籍番号、入室時間、退室時間)がCSV形式でダウンロードできます。
+
+デフォルトでは直近3ヵ月分ですが、 **[ 自分で設定する ]** ボタンを押して任意の期間を設定してのダウンロードもできます。
+
+#### 全入退室ログを確認
+
+画面下部分では、現在までのすべての入退室ログが閲覧できます。
+
+入室時間の新しい順に並んでいますのでダウンロードするほどでもないが、ここ数日の状況をちょっと確認したいときなどにご利用ください。
+
+**[ 表示件数 ]** ボタンを押すことで一度に表示される件数を調整できます。
+
+### このシステムについて
+
+本システムのバージョン情報を表示します。(デバッグ用)