From fdc289d88852142c7156d13904031e4cac8ff3ab Mon Sep 17 00:00:00 2001 From: Dave Hickin Date: Thu, 15 Oct 2015 09:16:20 +0100 Subject: [PATCH] Add new README Replace out of date HTML README with a new markdown one --- README.html | 82 ----------------------------------------------------- README.md | 57 +++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 82 deletions(-) delete mode 100644 README.html create mode 100644 README.md diff --git a/README.html b/README.html deleted file mode 100644 index 29015a0..0000000 --- a/README.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - EPICS pvData C++ - - - -

EPICS pvData C++
-Overview
-2010.08.10

-CONTENTS -
- -

Introduction

-
- -

This project has the begining of the C++ implementation of pvData. The -following is done:

-
-
introspection interfaces
-
The introspection interfaces for clients are described.
-
introspection implementation
-
The following have been implemented: Type, ScalarType, Field, - Scalar
-
test
-
A test of Scalar.
-
As mentioned below there are problems with the current - implementation.
-
-
- -

Building

-
- -

The project is structured as an epics base client application. Edit -configure/RELEASE so that it references your EPICS base and then just -type:

-
   make
- -

At the top. Then execute the test in the bin directory.

- -

pvDataApp has the following sub directories:

-
-
pv
-
pvData.h has the interface descriptions for client code.
-
factory
-
FieldCreateFactory.cpp has the current implementation
-
test
-
Has a test for the current implementation.
-
-
- -

Questions about Classes

-
- -

The pure virtual classes defined in pvData.h now work. But there are still -some things that are not so nice. Amoung these are:

- - -

HELP WILL BE GREATLY APPRECIATED. because I am still coming up to speed -with c++

-
- -

Garbage Collection

-
-

Not yet implemented. Lets get class structure correct first.

- - diff --git a/README.md b/README.md new file mode 100644 index 0000000..f131ebf --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +pvaDataCPP +========== + +pvDataCPP is a set of data types and utilities that form part of the EPICS V4 project. + + +Further Info +------------ + +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) + +(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). + +