Skip to content

Commit

Permalink
[DEV] docu: Anaconde outside of repo, do not collapse in QUICKSTART_A…
Browse files Browse the repository at this point in the history
…NACONDA.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
  • Loading branch information
treee111 authored Feb 24, 2022
1 parent 187e4ac commit ea732f7
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 16 deletions.
3 changes: 2 additions & 1 deletion copyFilesToDist.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand All @@ -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
Expand Down
24 changes: 9 additions & 15 deletions docs/QUICKSTART_ANACONDA.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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
Expand All @@ -57,22 +52,21 @@ 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.

# Create Anaconda Environment
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/
Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit ea732f7

Please sign in to comment.