diff --git a/README.md b/README.md index 2af55ed518a276a9a991085269138e876c0e5399..9426fcba6aa09f297a6b35f99f5f7adc55f889a7 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,27 @@ Client library for using Tango Station Control. Table of Contents: +- [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) - [Development](#development) - [Debug](#debug) - [Releasenotes](#releasenotes) +## Prerequisites + +This package uses [PyTango](https://pytango.readthedocs.io), which wraps the Tango C++ library. You will need to install the Tango C++ headers & library to allow `pip` to install PyTango as part of this package's requirements: + +Debian and Ubuntu provide these natively: + +```shell +apt-get install libtango-dev +``` + +Under Arch, install the [tango-cpp AUR package](https://aur.archlinux.org/packages/tango-cpp). + +For other distros and installation methods, see [Tango's Linux installation manual](https://tango-controls.readthedocs.io/en/latest/installation/tango-on-linux.html). + ## Installation Wheel distributions are available from the [gitlab package registry](https://git.astron.nl/lofar2.0/lofar-station-client/-/packages/), diff --git a/requirements.txt b/requirements.txt index 3043b88c0c118e78329cd6b654f46b4085cd7d17..83bb53bf8c93fb1db9396cc9f1c4b24f4901b91c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,4 +4,4 @@ numpy>=1.21.0 # BSD nptyping>=2.3.0 # MIT matplotlib>=3.5.0 # PSF pyDeprecate>=0.3.0 # MIT -tango # LGPLv3 +PyTango # GNU LGPL v3