[DEV] Update and clarify README & documentation & git files (#81)

* update git-files

- ignore macOS specific DS_Store files
- update PR template

* update docu "copy to wahoo"

- include authorization of ROAM
- combine authorization chapters into one
- rework docu and unify

* update readme

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,16 +6,20 @@ To get it merged faster, please use this template and replace as many "{...}" as
 
 a simple, one sentence summary of the ticket ensures the PR has a clear overall focus.
 
-{...}
+- {...}
 
 ## Considerations and implementations
 
 This is the main body of the PR, and varies massively by PR. A simple PR may have a single sentence here, others may have multiple paragraphs, diagrams, etc.
 
 {...}
 
+## How to test
+
+1. ...
+2. ...
+
 ## Pull Request Checklist
 - [ ] Reviewed the [Contributing Guidelines](https://github.com/treee111/wahooMapsCreator/blob/develop/.github/CONTRIBUTING.md)
     + Especially the [Pull-Requests](https://github.com/treee111/wahooMapsCreator/blob/develop/.github/CONTRIBUTING.md#Pull-Requests) section
-- [ ] commits (and commit-messages) are understandable
-- [ ] {...}
+- [ ] Commits (and commit-messages) are understandable

.gitignore

@@ -13,6 +13,7 @@ osmconvert_tempfile.*
 # in all folders
 **/__pycache__/*
 **/*.pyc
+**/*.DS_Store
 
 # mac/unix
 

README.md

@@ -45,35 +45,36 @@ Or use Anaconda to create a Python environment
 Download the latest Release from the ["Releases" Section](https://github.com/treee111/wahooMapsCreator/releases) and Save the folder on your drive. You can also clone the repository and have the latest coding.
 
 ## Run wahooMapsCreator
-wahooMapsCreator can be used in two different ways.
+wahooMapsCreator can be used in two different ways:
+- as [graphical window](#gui-graphical-user-interface) programm
+- as [command line](#cli-command-line-interface) programm
+
+Both ways support the same arguments to be used for the map-creation process. You can choose the arguments via GUI or as [CLI-arguments](#advanced-cli-usage).
 
-Both ways support the same arguments to be used for the map-creation process. You can choose them via GUI or as [CLI-arguments](#advanced-cli-usage).
 ### GUI (Graphical User Interface)
 
 From the `root` folder of wahooMapsCreator, run:
   - `python3 wahoo_map_creator.py` or
   - `python wahoo_map_creator.py`
-  - <img src="https://github.com/treee111/wahooMapsCreator/blob/develop/docs/gui.png" alt="wahooMapsCreator GUI" width=50%>
 
-### CLI (Command Line Interfaces)
+Set your arguments as required via the window:
 
-From the `root` folder of wahooMapsCreator, run:
-  - `python3 wahoo_map_creator.py <country_name>` or
-  - `python wahoo_map_creator.py <country_name>`
+<img src="https://github.com/treee111/wahooMapsCreator/blob/develop/docs/gui.png" alt="wahooMapsCreator GUI" width=35%>
 
-### Run wahooMapsCreator for your country
-It might be a good idea to run wahooMapsCreator first for a small country e.g. Malta to check if everything is running fine.
-In a next step you can run it for your own country.
+### CLI (Command Line Interface)
 
-### Basic CLI-Usage
-from the `root` folder of wahooMapsCreator, run:
+From the `root` folder of wahooMapsCreator, run:
 - `python3 wahoo_map_creator.py <country_name>` or
 - `python wahoo_map_creator.py <country_name>`
 
 Examples:
 - for Malta: `python3 wahoo_map_creator.py malta`
 - for Ireland: `python3 wahoo_map_creator.py ireland`
 
+### Run wahooMapsCreator for your country
+It might be a good idea to run wahooMapsCreator first for a small country e.g. Malta to check if everything is running fine.
+In a next step you can run it for your own country.
+
 ### Advanced CLI-Usage
 The script supports many arguments.
 For a list of all supported arguments, run:

docs/COPY_TO_WAHOO.md

@@ -3,10 +3,8 @@
 #### Table of contents <!-- omit in toc -->
 - [Steps to carry out](#steps-to-carry-out)
   - [Unzip Files](#unzip-files)
-  - [install adb](#install-adb)
-  - [Authorize Bolt to connect to Windows / macOS](#authorize-bolt-to-connect-to-windows--macos)
-    - [BOLT v1](#bolt-v1)
-    - [BOLT v2](#bolt-v2)
+  - [Install adb](#install-adb)
+  - [Authorize Wahoo device](#authorize-wahoo-device)
   - [Copy map files](#copy-map-files)
   - [Copy device theme](#copy-device-theme)
 - [Delete temp-files and Clear Cache](#delete-temp-files-and-clear-cache)
@@ -16,25 +14,27 @@
 ## Unzip Files
 unzip the desired country files
 
-## install adb
-You can download the lates ADB-tools (included in the SDK Platform Tools) for your OS here:
+## Install adb
+You can download the lates adb-tools (included in the SDK Platform Tools) for your OS here:
 https://developer.android.com/studio/releases/platform-tools
 
-## Authorize Bolt to connect to Windows / macOS
-### BOLT v1
-the Bolt must be authorized for adb (test with: adb devices):
-1. disconnect Bolt from your computer
-2. turn the Bolt on
-3. press the power button (you enter the settings menu)
-4. press the power button again (you return to the normal screen)
-5. connect the Bolt to your pc
+## Authorize Wahoo device
+The Wahoo device must be authorized for adb to be reachable from Windows and macOS. Adb authorization works different per Wahoo device and is decribed now.
 
-### BOLT v2
-adb authorization for Bolt v2:
-1. disconnect Bolt from your computer
-2. turn the Bolt on
-3. press the power, up and down buttons at the same time
-4. connect the Bolt to your computer
+1. disconnect device from your computer
+2. turn the device on
+3. press keys on device
+   * **BOLT v1 and ROAM**
+     * press the power button (you enter the settings menu)
+     * press the power button again (you return to the normal screen)
+   * **BOLT v2**
+     * press the power, up and down buttons at the same time
+4. connect the device to your pc
+
+Successful authorization can be tested via terminal / cmd:
+```
+adb devices
+```
 
 ## Copy map files
 copy the unzipped map folders to \ELEMNT-BOLT\USB storage\maps\tiles\8\