Update docs.

konkers · Jun 19, 2020 · 20e2e56 · 20e2e56
1 parent 9841cdd
commit 20e2e56
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 31 deletions.
diff --git a/docs/src/01_intro.md b/docs/src/01_intro.md
@@ -11,7 +11,7 @@ computer. It is heavily inspired by the amazing [EmoTracker](https://emotracker.
 
 Pollendina's notable features are:
 
-- Supports **Windows** and **MacOS**.
+- Supports **Windows**, **MacOS**, **Linux**.
 - Supports **auto tracking** using [usb2snes](http://usb2snes.com/) and
   [QUsb2snes](https://skarsnik.github.io/QUsb2snes/)
 - Dynamic map and objective support.
@@ -20,7 +20,6 @@ Pollendina's notable features are:
 
 Planned features:
 
-- Support for Linux.
 - Modules for randomizers other than Free Enterprise.
 - Developer documentation.
 

diff --git a/docs/src/02_install.md b/docs/src/02_install.md
@@ -0,0 +1,29 @@
+# Installation
+
+## Download
+
+The latest release can always be found on the
+[Releases Page](https://github.com/konkers/pollendina/releases/latest).
+There are packages for Windows (.msi), Mac (.dmg), and Linux (.deb). Download
+the appropriate package for your system.
+
+## Windows
+
+The Windows package is unsigned. When you run the installer you'll get
+presented with a **Windows protected your PC** dialog. Install, click
+_More info_ then _Run anyway_.
+
+## Mac
+
+The Mac app is unsigned. To run it the first time, right click on the app
+and select open. You be presented with a dialog saying that the application
+is unknown. Click _Open anyway_.
+
+## Linux
+
+If your distro supports `.deb` packages you can install using the following
+command:
+
+```bash
+sudo apt install pollendina-linux-vX.Y.Z.deb
+```
diff --git a/docs/src/02_quick_start.md b/docs/src/02_quick_start.md
diff --git a/docs/src/02_quick_start.md#action-bar b/docs/src/02_quick_start.md#action-bar
diff --git a/docs/src/02_quick_start_action_bar.md → docs/src/03_01_quick_start_action_bar.md b/docs/src/02_quick_start_action_bar.md → docs/src/03_01_quick_start_action_bar.md
@@ -7,10 +7,10 @@ work has been spend on its UI so expect it to change in the future. The
 actions are:
 
 - **Start/Stop auto tracking** starts and stops the auto tracker. See the
-  [Auto Tracking](./03_auto_tracking.md) Chapter for more information.
+  [Auto Tracking](./04_auto_tracking.md) Chapter for more information.
 - **Dump** dumps application state to the console. This is not useful
   unless you are running the app from the command line.
 - **Broadcast View** opens the broadcast view window. See the
-  [Broadcast View Window](./02_quick_start_broadcast_window.md) section for more information
-- **Config** opens the config window. See the [Config Window](./02_quick_start_config_window.md)
+  [Broadcast View Window](./03_05_quick_start_broadcast_window.md) section for more information
+- **Config** opens the config window. See the [Config Window](./03_04_quick_start_config_window.md)
   section for more information.
diff --git a/docs/src/02_quick_start_key_item_view.md → docs/src/03_02_quick_start_key_item_view.md b/docs/src/02_quick_start_key_item_view.md → docs/src/03_02_quick_start_key_item_view.md
diff --git a/docs/src/02_quick_start_map_view.md → docs/src/03_03_quick_start_map_view.md b/docs/src/02_quick_start_map_view.md → docs/src/03_03_quick_start_map_view.md
@@ -19,5 +19,5 @@ availability of checks at that location:
 
 Clicking one of the location circles will bring up the checks pop-up listing all
 the checks at that location and their states. The checks are color coded
-using the same scheme described in the [Key Item View](./02_quick_start_key_item_view.md) section.
+using the same scheme described in the [Key Item View](./03_02_quick_start_key_item_view.md) section.
 Clicking outside the popup will close it.
diff --git a/docs/src/02_quick_start_config_window.md → docs/src/03_04_quick_start_config_window.md b/docs/src/02_quick_start_config_window.md → docs/src/03_04_quick_start_config_window.md
diff --git a/docs/src/02_quick_start_broadcast_window.md → ...src/03_05_quick_start_broadcast_window.md b/docs/src/02_quick_start_broadcast_window.md → ...src/03_05_quick_start_broadcast_window.md
diff --git a/docs/src/03_quick_start.md b/docs/src/03_quick_start.md
@@ -0,0 +1,16 @@
+# Quick Start
+
+## Main Window
+
+![Main Window](images/main_window.png)
+
+The main window is divided into tree sections:
+
+1. [**Action Bar**](./03_01_quick_start_action_bar.md) at the top of the window.
+2. [**Key Item View**](./03_02_quick_start_key_item_view.md) at the left of the window.
+3. [**Map View**](./03_03_quick_start_map_view.md) at the right of the window.
+
+In addition the main window, there are two additional windows:
+
+1. [**Config Window**](./03_04_quick_start_config_window.md)
+2. [**Broadcast View Window**](./03_05_quick_start_broadcast_window.md)
diff --git a/docs/src/03_auto_tracking.md → docs/src/04_auto_tracking.md b/docs/src/03_auto_tracking.md → docs/src/04_auto_tracking.md
diff --git a/docs/src/04_credits.md → docs/src/05_credits.md b/docs/src/04_credits.md → docs/src/05_credits.md
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -1,11 +1,12 @@
 # Pollendina Multi-Tracker (to be) User Guide.
 
 - [Introduction](./01_intro.md)
-- [Quick Start](./02_quick_start.md)
-  - [Action Bar](./02_quick_start_action_bar.md)
-  - [Key Item View](./02_quick_start_key_item_view.md)
-  - [Map View](./02_quick_start_map_view.md)
-  - [Config Window](./02_quick_start_config_window.md)
-  - [Broadcast Window](./02_quick_start_broadcast_window.md)
-- [Auto Tracking](./03_auto_tracking.md)
-- [Credits](./04_credits.md)
+- [Installation](./02_install.md)
+- [Quick Start](./03_quick_start.md)
+  - [Action Bar](./03_01_quick_start_action_bar.md)
+  - [Key Item View](./03_02_quick_start_key_item_view.md)
+  - [Map View](./03_03_quick_start_map_view.md)
+  - [Config Window](./03_04_quick_start_config_window.md)
+  - [Broadcast Window](./03_05_quick_start_broadcast_window.md)
+- [Auto Tracking](./04_auto_tracking.md)
+- [Credits](./05_credits.md)