Software Package
================

This README describes how to use the downloaded software package containing firmware, user manual, client software and changelog.

1. From https://resources.satlab.com/software/ the product specific .tar package is downloaded.

2. Store the package in a known location on the PC, fx ``C:\\Satlab package\\Satlab product``.

3. Unpack the downloaded package in the stored location:

   1. On Windows OS .tar-files can be unpacked simply by right-clicking on the file and selecting ``Extract all...`` and then follow the on-screen instructions.
   2. On Linux OS use the command ``tar -xvf filename.tar`` to unpack the file in the folder where the .tar-file is stored.
    
   NOTE: If the .tar file is not unpacked, the interactive user manual will not work properly.

4. The location the .tar file is unpacked to, will now contain one folder named ``satlab-productname-vx.y.z``. In this folder the you will find:

   - Client software (``client``)
   - User manual (``doc``)
   - Product firmware (``firmware``) 
   - Changelog (``changelog.rst``)

5. To open the user manual go to the ``doc/doc`` folder and double click the ``index.html`` file. This will open the interactive user manual in a web browser.

For instruction on product firmware and client software installation, refer to the user manual.