• Antelope Release 5.10 Linux CentOS release 7.6.1810 (Core) 3.10.0 2020-05-12

 

NAME

contributed programs - overview and guidelines for contributions to Antelope software

DESCRIPTION

Overview

Antelope provides a productive development environment for end-users to create specialized processing applications.

Occasionally, members of the Antelope User Community release libraries and programs they've developed for broad use. These contributions are quite valuable to the Antelope community.

Both source-code and compiled versions of these contributed programs are available as described below. They may be installed alongside Antelope, to work in conjunction with the official Antelope release. Downloading the contributed code requires acceptance of the license terms placed on the software components by each contributing author.

Note that


BRTT DISCLAIMS ALL OWNERSHIP, LIABILITY, AND SUPPORT FOR CONTRIBUTED SOFTWARE NOT WRITTEN BY BRTT.

BRTT disclaims all ownership for contributed-code software other than software which BRTT has itself contributed. For help with contributed-code software, please contact the contributing author for the piece of software in question, who should be listed in the man-page for the piece of software. You may also wish to contact the Antelope Users Group email list, via the Antelope Users Group web site

http://www.antelopeusersgroup.org

When installed, all contributed-code software resides in $ANTELOPE/contrib (with bin, lib, man, data, and include subdirectories). As a convenience to our users, the Antelope setup.csh(1) and setup.sh(1) scripts add the correct paths for contributed code to the PATH, PFPATH(5), and DATAPATH(5) environment variables.

Availability

Source-code for Antelope contributed-code programs is currently hosted by the Antelope Users Group on github, specifically in the repository

https://github.com/antelopeusersgroup/antelope_contrib

In addition to obtaining source-code at the github web-site named above, users may elect to download tarballs of compiled contributed-code posted by the user community. The location of the tarballs is specified in the parameter file for the install_contrib(1) program. Note that the tarballs are operating-system dependent and there are thus multiple versions, organized into subdirectories by operating-system and architecture. Download the tarball appropriate for your machine and unpack it in the /opt/antelope directory.

The Antelope installer will give you the option of downloading the contributed-code while installing Antelope. If this option is not chosen at installation time, or is not possible because of Internet-access or firewall problems, the contributed-code may be installed at a later point via the install_contrib(1) program.

Development Guidelines

A few considerations during development or when software is put into the archive can make a world of difference. Here are a few items:

Verify that make clean, make purge, make, make Include and make install all work.

Don't make the program dependent on packages which are not incorporated into Antelope.

EXAMPLE

See the existing man pages for examples, or the $ANTELOPE/example subdirectories for examples of Makefiles.

SEE ALSO

install_contrib(1)
cbanner(3)
antelopemakefile(5)
antelope_man_page(5)
examples_c_pf(5)

AUTHOR

Daniel Quinlan
Printer icon