******************
Installation Guide
******************

Build from Source
=================

Please refer to the **README** in the cooresponding github repository for instructions to build the package from source.

.. _ref_add_debian_source:

Debian Repository
=================

C++ libraries and binaries (including the widget apps) are provided as ".deb" installation packages. There are two methods you can aquire and install the released debian packages:

* Download the ".deb" packages from the corresponding github repository and install with the "dpkg" command, e.g., $ sudo dpkg -i <package_name>.deb
* Install the packages from Weston Robot's apt-get server

Add Weston Robot's apt source
-----------------------------

Here are the steps you can follow to add the Weston Robot package source:

.. note::
   We updated our apt-get server in July 2023. If you've added Weston Robot's old apt source before, you will need to remove it first.

    .. code-block:: bash

        $ sudo rm /etc/apt/sources.list.d/weston-robot.list

Now follow the steps below to setup the repository.

1. Add the GPG key for the Weston Robot repository:

.. code-block:: bash

    $ sudo install -m 0755 -d /etc/apt/keyrings
    $ curl -fsSL http://deb.westonrobot.net/signing.key | sudo gpg --dearmor -o /etc/apt/keyrings/weston-robot.gpg
    $ sudo chmod a+r /etc/apt/keyrings/weston-robot.gpg

2. Add the Weston Robot repository to your system's software repository list:

.. code-block:: bash

    $ echo \
        "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/weston-robot.gpg] http://deb.westonrobot.net/$(lsb_release -cs) $(lsb_release -cs) main" | \
        sudo tee /etc/apt/sources.list.d/weston-robot.list > /dev/null

3. Now you can update the index and install packages with "apt-get" command. 

.. code-block:: bash

    $ sudo apt-get update
    $ sudo apt-get install <package_name>

**Note:** Installation of additional third-party dependency packages may be required for a package provided by Weston Robot. Please follow the package-specific instructions.