natour

natour provides applications and a library for reports on nature activities


License
MIT
Install
gem install natour -v 0.0.1

Documentation

natour

This RubyGem provides applications and a library for reports on nature activities.

Installation

  1. Install the Prerequisites first

  2. Open a terminal window and run gem install natour (use sudo on Ubuntu)

Prerequisites

Install the required components by following the instructions below. Please read the installation guide of the components if you encounter any problems or if your OS is not listed below (e. g. OS X).

Windows

  1. Download and install the latest version from RubyInstaller for Windows

  2. Download and install the latest version from Google Chrome-Webbroser

  3. Add BROWSER_PATH=path/to/chrome.exe to the environment variables

  4. Log off Windows and back on again to ensure the environment variable takes effect

Ubuntu

  1. Open a terminal window and run

    sudo apt install ruby build-essential patch ruby-dev zlib1g-dev liblzma-dev libvips42
    wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
    sudo apt install ./google-chrome-stable_current_amd64.deb

Application

Command Description

natour

Create reports in AsciiDoc format from a directory with GPS tracks, images and species lists. After editing the AsciiDoc files, they can be converted to various formats, including PDF and HTML. Use natour --help to get more information.

Library

The basic use is shown in the following example. For details, see the source code and unit tests.

require 'natour'

Natour::create('path/to/dir')
require 'natour'

Natour::convert('path/to/dir/report.adoc')