From 06836425a11d564b05ef2dca14b69218fb6a2736 Mon Sep 17 00:00:00 2001 From: Commander1024 Date: Fri, 24 Apr 2020 23:05:17 +0200 Subject: [PATCH] Added Setup Guide and link to that page in quick start order. --- download_gps.md | 2 +- setup_rad_tag.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 setup_rad_tag.md diff --git a/download_gps.md b/download_gps.md index c27f2cf..23c4395 100644 --- a/download_gps.md +++ b/download_gps.md @@ -2,4 +2,4 @@ This significantly differs from device to app. Goal has to be a .gpx file on your computer. It doesn't matter how you get it there from your phone, smartwatch or standalone GPS device. -Proceed with [How to use rad-tag](howto_rad_tag). +Proceed with [Set up rad_tag](setup_rad_tag). diff --git a/setup_rad_tag.md b/setup_rad_tag.md new file mode 100644 index 0000000..fe2d1b8 --- /dev/null +++ b/setup_rad_tag.md @@ -0,0 +1,35 @@ +# Setup rad_tag + +You can use rad_tag in one of the following two ways: + +1. You can satisfy all dependencies using your distro's packet manager and just run the script from git. +2. Set up a pipenv and satisfy dependencies locally in the VirtualEnv. + +## Dependencies +Right now it depends on the following non-core Python 3 libraries. These can be installed using the package manager of your distribution. + + * [py3exiv2](https://pypi.org/project/py3exiv2/) A Python 3 binding for (lib)exiv2. + * [pytz](https://pypi.org/project/pytz/) World timezone definitions, modern and historical. + * [gpxpy](https://pypi.org/project/gpxpy/) gpx-py is a python GPX parser. GPX (GPS eXchange Format) is an XML based file format for GPS tracks. + +If you chose the first, install the dependencies manually and run my script, otherweise follow the next instructions. + +### Setting up a virtual environment using pipenv + +If you prefer to use more updated versions of the dependencies or you do not want to use Python dependencies into your system, I prepared a pipenv virtual environment for you. + +Using `pipenv install` all dependencies will be installed automatically. With `pipenv shell` you can source the venv. + +For py3exivv2 to work / compile the following dependencies must be installed - preferably from your system's package manager: + + * [exiv2](http://www.exiv2.org/) and it's development package. Exiv2 is a Cross-platform C++ library and a command line utility to manage image metadata. + * [boost](https://www.boost.org/) and it's development package. Boost provides free peer-reviewed portable C++ source libraries. + * [boost.python3](http://www.boost.org/libs/python/doc/index.html) and it's development package. A C++ library which enables seamless interoperability between C++ and the Python programming language. + +#### Debian / Ubuntu +sudo apt install pipenv build-essential python-all-dev libexiv2-dev libboost-python-dev + +#### Fedora +sudo dnf install pipenv exiv2-devel boost-devel boost-python3-devel make automake gcc gcc-c++ + +Proceed to [How to use rad_tag](howto_rad_tag). \ No newline at end of file