From 0e2ade1e07151c55fdffedd9b9e91b87172eaf00 Mon Sep 17 00:00:00 2001 From: Simon Rose <simon.rose@ess.eu> Date: Mon, 16 Nov 2020 10:26:02 +0100 Subject: [PATCH] Updated README --- README.md | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 5d323dd0..720e1e68 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,25 @@ -# ESS customized require originated from PSI +# ESS require -The following files are touched: +`require` is a fork of [PSI require](https://github.com/paulscherrerinstitute/require). Multiple changes +have been put in place to fit within the e3 concept, some of which are outlined below. This is not truly +a stand-alone EPICS module, but fits together with its "e3 wrapper", located at +[e3-require](https://gitlab.esss.lu.se/e3/e3-require). Documentation for this can be found at +[e3.pages](http://e3.pages.esss.lu.se/design/2_require.html). -* require.c -* driver.makefile +## Changes from PSI require -And ESS doesn't use iocsh, we have the indepdent iocsh.bash (under tools). +The main changes are the following. In all cases we have removed support for EPICS base 3.x, as well as +VxWorks. Other changes +* require.c: We have changed the way that versioning is handled to include the option of build numbers, which + we have found are necessary to handle some dependency issues. See the above documentation. +* driver.makefile: A lot of simplifications have been added based on ESS's requirements (in particular, not + needing to have EPICS base 3.x and 7.x together). There are also a number of additions to allow some extra + flexibility in installing e.g. header files. +* iocsh.bash: We have replaced the PSI startup script `iocsh` with an ESS version, `iocsh.bash`. -# Compatibility with different versions of require - -* http://github.com/icshwi/require-ess - - The differences here are that require-ess forces the IOC developer to specify a verions number, which does not - make sense in the context of using Conda as a deployment tool. As a result, this build is currently up-to-date with - https://github.com/icshwi/require-ess/releases/tag/v3.1.2 - -* http://github.com/paulscherrerinstitute/require - - All of the commits up until https://github.com/paulscherrerinstitute/require/tree/912cccdbd3ebff32210b0e6331886049f9748770 - are included in this branch; the remaining commits until https://github.com/paulscherrerinstitute/require/tree/2439791953107fa1a88bdfcd8aa4554dc2ec3a6a - are to support further control over matching module versions, which is not necessary in Conda. As such, we consider this release to be - up to date with https://github.com/paulscherrerinstitute/require/tree/2439791953107fa1a88bdfcd8aa4554dc2ec3a6a - -# Original README - +# Original PSI README ``` require "<module>" [,"<version>"] [,"<macro1>=<value2>, <macro2>=<value2>"] -- GitLab