Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jevarlec committed May 17, 2023
1 parent d9e145e commit 55100a4
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 15 deletions.
6 changes: 6 additions & 0 deletions configure/RELEASE
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

#RELEASE Location of external products

# Required external module paths:
# ASYN - asynDriver
# AUTOPARAM - autoparamDriver
# EPICS_BASE - EPICS base

EPICS_BASE=$(EPICS_BASE)
ASYN=$(MODULES)/asyn
AUTOPARAM=$(MODULES)/autoparamdriver

Expand Down
29 changes: 14 additions & 15 deletions documentation/source/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,16 @@ Pre-requisite software:
* **Boost**: Boost C++ libraries
* **gcc**: GNU Compiler Collection
* **g++**: GCC for C++
* **git**: version control system
* **autoparamDriver**: see :ref:`instructions below <autoparam-install>`
* **autoparamDriver**: at least v2.0.0, see :ref:`instructions below <autoparam-install>`

ADS device support software includes :ref:`beckhoff-adslib-ref` as a submodule.

.. _autoparam-install:

AutoparamDriver
========================
The following is a quickstart for compiling Autoparam on Linux. Refer to Autoparam README for more information.

Download the latest stable version from `Github <www.github.com/cosylab/autoparamDriver>`_.

The provided ``configure/RELEASE`` file assumes that the module's parent directory contains a *RELEASE.local* file with the required module paths (i.e. *ASYN* and *EPICS_BASE*):
Expand Down Expand Up @@ -114,24 +115,22 @@ The provided ``configure/RELEASE`` file assumes that the module’s parent direc
# ASYN - asynDriver
# AUTOPARAM - autoparamDriver
# EPICS_BASE - EPICS base
# External modules are expected to be defined in a RELEASE.local file located
# in $(TOP)'s parent directory.
-include $(TOP)/../RELEASE.local
Set the target installation location in ``configure/CONFIG_SITE`` (optional step):
RELEASE file also contains an option to force compiling with C++11 on Linux. Use this if your toolchain is not compatible with a newer C++ standard.

.. code-block:: makefile
:emphasize-lines: 6
# Set to YES in order to compile with C++11 on Linux, otherwise it will use 14.
# Default is NO
LINUX_USE_CPP11=NO
# CONFIG_SITE
# ... <removed for brevity>
If you compile on Windows and you have TwinCAT installed, you might prefer using the ADS library included with your TwinCAT installation. You can define the path to your TwinCAT installation using TCDIR variable in the RELEASE file.

# To install files into a location other than $(TOP) define
# INSTALL_LOCATION here.
INSTALL_LOCATION=/opt/epics/modules/ads
.. code-block:: makefile
# ... <removed for brevity>
## define TCDIR to use ADS library from local Beckhoff TwinCAT install
## rather than ADS in submodule
#TCDIR=C:/TwinCAT
Compile the module:

Expand Down

0 comments on commit 55100a4

Please sign in to comment.