From d776f6eaf03c058597c05b3308636d95223b6c6e Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Mon, 17 Dec 2018 15:00:28 -0600 Subject: [PATCH] Update and unify README.md --- README.md | 61 +++++++++---------------------------------------------- 1 file changed, 10 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 7dee717..76309f4 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,16 @@ -pvaDataCPP -========== +# pvaDataCPP -pvDataCPP is a set of data types and utilities that form part of the EPICS V4 project. +The EPICS **pvData** API provides a set of classes and utilities that form the core of the EPICS PVA implementation. +The pvDataCPP module is a part of the EPICS software toolkit that implements pvData structures as C++ class objects. -Further Info ------------- +## Links -Consult the documents in the documentation directory, in particular - -* pvDataCPP.html -* RELEASE_NOTES.md - -Also see the [EPICS Version 4 website](http://epics-pvdata.sourceforge.net) - -Prerequisites -------------- - -The pvDataCPP requires recent versions of the following software: - -1. EPICS Base (v3.14.12.3 or later) -2. EPICS4 pvCommonCPP (4.1.0 or later) - -(pvCommonCPP may not be needed depending on host/compiler.) - - -Building --------- - -Building uses the make utility and the EPICS base build system. - -The build system needs the location of the prerequisites, e.g. by placing the -lines of the form - - PVCOMMON = /home/install/epicsV4/pvCommonCPP - EPICS_BASE = /home/install/epics/base - -pointing to the locations in a file called RELEASE.local -in the configure directory or the parent directory of pvDataCPP. - -With this in place, to build type make - - make - -To perform a clean build type - - make clean uninstall - -To run the unit tests type - - make runtests - -For more information on the EPICS build system consult the -[Application Development guide](http://www.aps.anl.gov/epics/base/R3-14/12-docs/AppDevGuide.pdf). +- General information about EPICS can be found at the + [EPICS Controls website](https://epics-controls.org). +- API documentation for this module can be found on its + [Github Pages website](https://epics-base.github.io/pvDataCPP/). +## Building +This module is included as a submodule of a full EPICS 7 release and will be compiled during builds of that software.