diff --git a/README.htm b/README.htm index 05cdf4a81..96303d343 100644 --- a/README.htm +++ b/README.htm @@ -19,8 +19,8 @@ EPICS base

Release 3.14.0alpha2

-

-What is EPICS base?

+

+What is EPICS base?

The Experimental Physics and Industrial Control Systems (EPICS) is an extensible set of software components and tools with which application @@ -31,22 +31,22 @@ of EPICS without which EPICS would not function. EPICS base allows an arbitrary number of target systems, IOCs (input/output controllers), and host systems, OPIs (operator interfaces) of various types.
-

-What is new in this release?

+

+What is new in this release?

This version of EPICS base contains significant changes and offers major improvements in functionality over previous versions. Please check the RELEASE_NOTES file in the distribution for description of changes and release migration details.
-

-Copyright

+

+Copyright

Please review the COPYRIGHT* files included in the distribution for legal terms of usage.
-

-Supported platforms

+

+Supported platforms

Currently this version of EPICS base has been built on the following hosts and targets. If you are trying to build EPICS base on a @@ -82,8 +82,8 @@ Cross compile target platforms (operating system - architecture)
RTEMS-pc386
-

-Supported compilers

+

+Supported compilers

This version of EPICS base has been built and tested using the host vendor's C and C++ compilers as well as the GNU gcc and g++ compilers. @@ -93,8 +93,8 @@ builds. Check definitions of ACC and CCC in base/configure/os/CONFIG.<host>.& or the definitions for GCC and G++ if ANSI=GCC and CPLUSPLUS=GCC are specified in CONFIG_SITE.
-

-Software requirements

+

+Software requirements

GNU make
You must use GNU make, gnumake, for any EPICS builds.  Set your @@ -121,16 +121,16 @@ source files which require c preprocessing to generate solaris-sparc object files (*.st files),  gcc must be in your path.
 
-

-Host system storage requirements

+

+Host system storage requirements

The GNU zipped tar file is approximately 1.4 MB in size. The unzipped untarred distribution source tree is approximately 6 MB. The build created files for each host take approximately 40 MB and the build created files for each target take approximately 10 MB.
-

-Documentation

+

+Documentation

EPICS documentation is available on the WWW via the EPICS home page at APS:  URL http://www.aps.anl.gov/Epics
@@ -139,8 +139,8 @@ page at APS:  URL http://www.aps.anl available on the IOC software R3.14 EPICS WWW page which can be accessed from the APS EPICS home page. -

-WWW pages

+

+WWW pages

@@ -161,8 +161,8 @@ Mailing Lists

EPICS home page for subscription instructions.
-

-Directory Structure

+

+Directory Structure

Distribution directory structure:
     base                         @@ -271,18 +271,14 @@ Installed header files Installed os specific header files
     base/templates               Installed templates -

-Build related components

+

+Build related components

  • base/README* files
    • -
      -

      -
      -
      -

    README.htm           +


    README.htm           Instructions for setup and building epics base
                         (i.e. this document) @@ -296,11 +292,7 @@ instructions

  • base/startup directory - contains scripts to set environment and path
    • -
      -

      -
      -
      -

    EpicsHostArch       c shell script +


    EpicsHostArch       c shell script to set EPICS_HOST_ARCH env variable
    EpicsHostArch.pl    perl script to set EPICS_HOST_ARCH env variable @@ -316,7 +308,9 @@ WIN32 bat file to set path and env variables

  • base/configure  directory - contains build definitions and rules
    • -


    CONFIG.CrossCommon    Cross build definitions +
      +

      +

    CONFIG.CrossCommon    Cross build definitions
    CONFIG_ADDONS         Definitions for <osclass> and DEFAULT options
    CONFIG_BASE           @@ -353,7 +347,9 @@ Rules specific to a <top> dir (uninstall and tar)

  • base/configure/os directory - contains os-arch specific definitions
    • -


    CONFIG.<host>.<target>      Specific +
      +

      +

    CONFIG.<host>.<target>      Specific host-target build definitions
    CONFIG.Common.<target>      Specific target definitions for all hosts @@ -369,7 +365,9 @@ R3.13 arch compatibility definitions

  • base/configure/tools directory - contains Perl scripts used for the build
    • -


    cp.pl                   +
      +

      +

    cp.pl                   This Perl script copies an existing file
    installEpics.pl         Installs built files into install directories. @@ -392,8 +390,8 @@ Changes CapFast VAR(xxx) to $(xxx) notation
    rm.pl                   Quietly removes an existing file.

    -

    -Building EPICS base (Unix and Win32)

    +

    +Building EPICS base (Unix and Win32)

    Unpack file
    Unzip and untar the distribution file. Use WinZip on Windows @@ -461,8 +459,8 @@ directory of an EPICS  directory structure before each complete rebuild to ensure that all components will be rebuilt.
    -

    -Multiple host platforms

    +

    +Multiple host platforms

    You can build using a single EPICS directory structure on multiple host systems and for multiple cross target systems. The intermediate and @@ -479,8 +477,8 @@ you must have the proper host/target c++ cross compiler and target header files and the base/configure/os directory must have the appropriate configure files.
    -

    -Examples

    +

    +Examples

    A perl tool, makeBaseApp.pl is included in the distribution file. This script will create a sample application that then can be built @@ -490,8 +488,8 @@ create a sample extension that can be built and executed. The makeBaseApp.pl and makeBaseExt.pl scripts are installed into the install location bin/<hostarch> directory during the base build.
    -

    -Example base application

    +

    +Example base application

    Instructions for building and executing a 3.14 example application can be found in the section "Example Application" of Chapter 2, "New Features