GitBook: [master] 5 pages and one asset modified

exam-simulator · Mar 14, 2019 · 29c215f · 29c215f
1 parent d0fbfdf
commit 29c215f
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 15 deletions.
diff --git a/docs/.gitbook/assets/annotation-2019-03-14-003628.png b/docs/.gitbook/assets/annotation-2019-03-14-003628.png
diff --git a/docs/README.md b/docs/README.md
@@ -1,15 +1,18 @@
-# Exam Simulator
+# Exam Simulator JS
 
-**Exam Simulator** is a JSON based, open source, exam simulator.
+JSON based, open source and free exam simulator.
 
 ![Windows](https://img.shields.io/badge/platform-windows-lightgrey.svg) ![AppVeyor](https://img.shields.io/appveyor/ci/exam-simulator/simulator.svg?style=popout)
 
-![Macos](https://img.shields.io/badge/platform-macos-lightgrey.svg) ![Travis (.org)](https://img.shields.io/travis/exam-simulator/simulator.svg?style=popout)
+![Macos](https://img.shields.io/badge/platform-macos-lightgrey.svg) ![Travis \(.org\)](https://img.shields.io/travis/exam-simulator/simulator.svg?style=popout)
 
-![GitHub All Releases](https://img.shields.io/github/downloads/exam-simulator/simulator/total.svg?style=popout)
+![](https://img.shields.io/github/downloads/exam-simulator/simulator/total.svg?style=popout)
+
+### [Documentation](https://exam-simulator.gitbook.io/exam-simulator)
 
 ## Donate
 
-Software is free, but I won't turn down a donation. 🤑
+The app is free, but I won't turn down a donation. 🤑
 
 [![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BKMDFU4LLE6NU&source=url)
+
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,6 +1,6 @@
 # Table of contents
 
-* [Exam Simulator](README.md)
+* [Exam Simulator JS](README.md)
 * [Installation](installation.md)
 * [Getting Started](getting-started.md)
 * [Schema](schema.md)

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -2,7 +2,7 @@
 
 ### Demo Exam
 
-The quickest way to get started is to take the _Demo Exam_ that ships with the software. Click the _Demo Exam_ item and you should see its cover page. The demo is based on the popular documentary _Marking a Murderer_.
+The quickest way to get started is to try the _Demo Exam_ that ships with the software. Click the _Demo Exam_ item and you should see its cover page. The demo is based on the popular documentary _Marking a Murderer_.
 
 ![Demo Exam Cover](.gitbook/assets/annotation-2019-03-12-141810.png)
 
@@ -14,19 +14,41 @@ Taking a test is intuitive and something most of us have done our entire lives.
 
 ### Exam Controls
 
-The left portion of the screen contains the menu drawer and question grid. Navigate to any question by clicking the corresponding square. Question status is quickly visible by color. _Bookmark_ a question if you aren't sure of the answer or want to review it before ending the exam. Do this my clicking the bookmark icon in the upper right corner. 
+#### Question Grid
+
+The left portion of the screen contains the menu drawer and question grid. Navigate to any question by clicking the corresponding square. Question status is quickly visible by color. _Bookmark_ a question if you aren't sure of the answer or want to review it before ending the exam. Do this my clicking the bookmark icon. 
 
 ![Question Grid](.gitbook/assets/annotation-2019-03-12-144917.png)
 
-Most exams are timed and budgeting available time can be an important skill. The exam timer is located along the footer, on the left. When time is low the display will turn red warning the user. The timer can be disabled in _Settings_. 
+#### Timer
+
+Many exams are timed and budgeting available the clock can be an important skill. The exam timer is located in the footer. When time is low the display will turn red.
 
 ![15 Seconds on Timer](.gitbook/assets/annotation-2019-03-12-145826.png)
 
+#### Arrows
+
 Use the navigation arrows to cycle through questions. The interior buttons move to the previous or next question, while the exterior buttons move to the first or last question. 
 
 ![Question Arrow Buttons](.gitbook/assets/annotation-2019-03-12-151051.png)
 
-Toggling between _All Questions_ and _Marked Questions_ in the menu drawer changes the group of question being cycled through. When in _Bookmarked Mode_ a message will be displayed to let the user know.
+#### Question Modes
+
+Switch between _All Questions_ and _Bookmarked Questions_ from the menu drawer to change the group of questions being cycled. 
 
 ![Bookmarked Question in Bookmarked Mode](.gitbook/assets/annotation-2019-03-12-151034.png)
 
+#### Show Answer
+
+Show are correct answer by clicking _Show Answer_ from the menu drawer. An _Explanation_ box will appear and be scrolled into view. The correct answer, answer status \(Correct/Incorrect\), explanation and notes, if any will appear here. 
+
+![Expanation](.gitbook/assets/annotation-2019-03-14-003628.png)
+
+#### Pause Exam
+
+Pause the exam by clicking _Pause Exam_ from the menu drawer. The timer will stop, and interaction with the exam is disabled. Click _Resume Exam_ to continue.
+
+#### End Exam
+
+End the exam by clicking _End Exam_ from the menu drawer. A dialog will ask for confirmation and then display a summary of exam results.
+
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,8 +1,8 @@
 # Installation
 
-The application is currently in _alpha_ release. There is no _Code Signature_, therefore, your operating system/browser may display warnings. On Windows choosing **Run Anyway** solves this problem.
+The application is currently in _alpha_ release. There is no _Code Signing_, therefore, your operating system/browser may display warnings when downloading the executable. The _Windows_ version will automatically update when a new releases occur. Automatic updates are not currently supported on _MacOS._
 
-[Download @ GitHub Releases](https://github.com/exam-simulator/simulator/releases)
+### [Download](https://github.com/exam-simulator/simulator/releases)
 
 ### Windows
 

diff --git a/docs/schema.md b/docs/schema.md
@@ -4,7 +4,7 @@ description: Description of exam schema.
 
 # Schema
 
-Exam files use the `.json` extension. **JSON**, or **JavaScript Object Notation** is a data format that is supported by many programming languages. Files must use this extension and adhere to the schema defined below.
+Exam files use the `.json` extension. _JSON_, or _JavaScript Object Notation_ is a data format that is supported by many programming languages. Files must use this extension and adhere to the schema defined below.
 
 [Exam Maker](https://exam-maker.herokuapp.com/) allows users to create and share exams without knowing this schema. However, exams can be created in any text editor.
 
@@ -78,7 +78,7 @@ Exam files use the `.json` extension. **JSON**, or **JavaScript Object Notation*
 | :--- | :--- | :--- |
 | **id** | unique identifier | `string` |
 | **name** | author name | `string` |
-| **image** | author avatar | `string` |
+| **image** | author image URL | `string` |
 
 #### 
 
@@ -101,7 +101,7 @@ Exam files use the `.json` extension. **JSON**, or **JavaScript Object Notation*
 | **0** | multiple choice | `[true,false,false,false]` |
 | **1** | multiple answer | `[true,true,false,false]` |
 | **2** | fill in the blank | `[answer,variation,another]` |
-| **3** | list order | `[first,second,third]` |
+| **3** | list order | `[]` |