diff --git a/README.md b/README.md index 45c4df1..62b3d7e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ # 2020年版イントロクイズ -2020年版イントロクイズです。完全オフライン版とオンライン版があります。 +2020年版イントロクイズです。完全オフライン版と[オンライン版](test-wsplay/TEST.md)があります。 (2020/8/18作成) -# 各フォルダ +## オンライン版 + +オンライン版は[test-wsplay](test-wsplay/TEST.md)に説明があります。 + +# オフライン版イントロクイズ + +当システムは音楽を再生、ストップの機能のみを持ちます。外部ツールと連携して使うことが前提なのであらかじめご了承ください。 + +### フォルダ構成 ```bash ├── README.md ├── public @@ -27,14 +35,14 @@ └── start.erb ``` -# Start IntroQuiz! +## Start IntroQuiz! イントロクイズを行うための準備と手順を以下に示す。 -## 必要なライブラリ一覧 +### 必要なライブラリ一覧 * sinatra * sinatra-contrib -## インストール +### インストール ```bash gem install sinatra @@ -49,29 +57,30 @@ ``` 2. Firefox等のURLバーに以下を入力。 +```bash localhost:4567 +``` イントロクイズ with ZOOM! という画面が表示されればOK。 # 操作方法 -表の左の問題1..をクリックで音楽が流れる。 -画面左上の3つのボタンでそれぞれ再生、停止、サビ再生を行う。何もクリックせずに再生ボタンを押しても何も流れないため注意すること。 +表の問題1..をクリックで音楽が流れます。 +画面左上の3つのボタンはそれぞれ + +* 再生 +* 停止 +* サビ再生 + +の機能を持ちます。何もクリックせずに再生ボタンを押しても何も流れないため注意してください。 本システムには非同期通信がありません。使用する際には外部ツールを使用してください。 今回は[ZOOM](https://zoom.us/jp-jp/meetings.html)のチャット機能と2つ画面を使用して行う前提です。 -ホストがZOOMのScreenShareで本システムの画面を共有し、参加者はZOOMのチャットから反応する形です。 +ホストがZOOMのShareScreenで本システムの画面を共有し、参加者はZOOMのチャットから反応する形です。 # 音楽ファイルについて -曲は全て[public/audio](public/audio)下に置いてください。そこ以外だと反応しません。 -mp3ファイルを置いた上で、csvファイルの形式は以下の通りです。 +曲は全て[public/audio](public/PUBLIC.md)下に置いてください。形式はリンクを参照してください。 -| 曲名 | ファイル名 | ヒント | 作者 | サビ秒数 | -----|---- |---- |---- |---- -| ex1 | ... | ... | ... | ... | ... | -| ex2 | ... | ... | ... | ... | ... | - -start.jsでcsvファイルの1行目を飛ばす処理をしているので、1行目を見出しとして、2行目から記載してください。 - + \ No newline at end of file