From ea732f7af4368e4f0b0f98dc36f1e9bd3be4e3d9 Mon Sep 17 00:00:00 2001
From: Benjamin K <53038537+treee111@users.noreply.github.com>
Date: Thu, 24 Feb 2022 21:51:30 +0100
Subject: [PATCH] [DEV] docu: Anaconde outside of repo, do not collapse in
 QUICKSTART_ANACONDA.md (#98)

* update documentation

- do not collapse in quickstart/installation part
- don't use Anaconda env in repo, use standard way outside of the repo
- move (not needed) files to docs/old/ directory

* only include .md filesin dir docs/ to generated .zip files
---
 copyFilesToDist.sh                   |  3 ++-
 docs/QUICKSTART_ANACONDA.md          | 24 +++++++++---------------
 docs/{ => old}/QUICKSTART_MACOS.md   |  0
 docs/{ => old}/QUICKSTART_WINDOWS.md |  0
 4 files changed, 11 insertions(+), 16 deletions(-)
 rename docs/{ => old}/QUICKSTART_MACOS.md (100%)
 rename docs/{ => old}/QUICKSTART_WINDOWS.md (100%)

diff --git a/copyFilesToDist.sh b/copyFilesToDist.sh
index 7431ab88..437c4876 100755
--- a/copyFilesToDist.sh
+++ b/copyFilesToDist.sh
@@ -24,6 +24,7 @@ mkdir -p ./common_python
 mkdir -p ./common_resources
 mkdir -p ./conda_env
 mkdir -p ./tooling
+mkdir -p ./docs
 
 # copy files into dist-folder
 cp -a ../../common_python/*.py ./common_python/
@@ -33,7 +34,7 @@ cp -a ../../common_resources/json/ ./common_resources/json
 cp -a ../../common_resources/tag_wahoo_adjusted/ ./common_resources/tag_wahoo_adjusted
 cp -a ../../common_resources/tag_wahoo_initial/ ./common_resources/tag_wahoo_initial
 
-cp -a ../../docs ./docs
+cp -a ../../docs/*.md ./docs/
 cp -a ../../wahoo_map_creator.py ../../CHANGELOG.md ../../README.md ./
 
 # file for virtual environments / legacy pip install
diff --git a/docs/QUICKSTART_ANACONDA.md b/docs/QUICKSTART_ANACONDA.md
index 9ded9773..6dad5496 100644
--- a/docs/QUICKSTART_ANACONDA.md
+++ b/docs/QUICKSTART_ANACONDA.md
@@ -3,12 +3,11 @@
 #### Table of contents <!-- omit in toc -->
 - [Download and Install required programs](#download-and-install-required-programs)
   - [Anaconda](#anaconda)
-  - [Windows, macOS, Linux](#windows-macos-linux)
-    - [Install Java](#install-java)
+  - [Java](#java)
   - [macOS, Linux only](#macos-linux-only)
     - [homebrew](#homebrew)
     - [OSM-tools](#osm-tools)
-  - [wahooMapsCreator](#wahoomapscreator)
+- [wahooMapsCreator](#wahoomapscreator)
 - [Create Anaconda Environment](#create-anaconda-environment)
 - [Run wahooMapsCreator](#run-wahoomapscreator)
 
@@ -22,17 +21,13 @@ https://www.anaconda.com/products/individual
 
 2. Install `Anaconda Individual Edition` with default settings
 
-## Windows, macOS, Linux
-<details>
-  <summary>The following programs are needed on every OS</summary>
+## Java
+Java needs to be installed for every OS (Windows, macOS, Linux)
 
-### Install Java
 https://www.oracle.com/technetwork/java/javase/downloads
-</details>
 
 ## macOS, Linux only
-<details>
-  <summary>The following programs are needed for macOS and Linux</summary>
+The following programs are needed for macOS and Linux
 
 ### homebrew
 Install using terminal
@@ -57,10 +52,9 @@ brew install osmosis
 ```
 * Put the .jar into the `plugins` directory. You may have to enable showing hidden folders in finder via `Command + Shift + . (period)`
 * more information: https://github.com/mapsforge/mapsforge/blob/master/docs/Getting-Started-Map-Writer.md#plugin-installation
-</details>
 
-## wahooMapsCreator
-Download the latest .zip file from the [Releases](https://github.com/treee111/wahooMapsCreator/releases) page and save the folder on your drive. Extract the folder.
+# wahooMapsCreator
+Download the latest .zip file from the [Releases](https://github.com/treee111/wahooMapsCreator/releases) page for your OS and save the folder on your drive. Extract the folder.
 
 You can also clone the repository to have the latest coding.
 
@@ -68,11 +62,11 @@ You can also clone the repository to have the latest coding.
 1. Open (or change to) the root of the extracted wahooMapsCreator folder in terminal (macOS/Linux) or **Anaconda Prompt** (Windows, via Startmenu)
 2. Create a new Anaconda environment via
 ```
-conda env create --prefix ./envs -f ./conda_env/enduser.yml
+conda env create -f ./conda_env/enduser.yml
 ```
 3. activate Anaconda environment with the command printed out
 ```
-conda activate <PATH_TO_FOLDER>/wahooMapsCreator/envs
+conda activate enduser
 ```
 
 Additional informations: https://opensourceoptions.com/blog/how-to-install-gdal-with-anaconda/
diff --git a/docs/QUICKSTART_MACOS.md b/docs/old/QUICKSTART_MACOS.md
similarity index 100%
rename from docs/QUICKSTART_MACOS.md
rename to docs/old/QUICKSTART_MACOS.md
diff --git a/docs/QUICKSTART_WINDOWS.md b/docs/old/QUICKSTART_WINDOWS.md
similarity index 100%
rename from docs/QUICKSTART_WINDOWS.md
rename to docs/old/QUICKSTART_WINDOWS.md