Skip to content

Latest commit

 

History

History
90 lines (73 loc) · 2.59 KB

README.md

File metadata and controls

90 lines (73 loc) · 2.59 KB
Raw

OpenCog Utilities

CircleCI

The OpenCog utilities is a miscellaneous collection of C++ utilities use for typical programming tasks in multiple OpenCog projects. These include:

  • thread-safe queues, stacks and sets
  • asynchronous method caller
  • thread-safe resource pool
  • thread-safe backtrace printing
  • high-performance signal-slot
  • random tournament selection
  • OS portability layers.

The main project site is at http://opencog.org

Prerequisites

To build the OpenCog utilities, the packages listed below are required. With a few exceptions, most Linux distributions will provide these packages. Users of Ubuntu 14.04 "Trusty Tahr" may use the dependency installer at scripts/octool. Users of any version of Linux may use the Dockerfile to quickly build a container in which OpenCog will be built and run.

boost

C++ utilities package http://www.boost.org/ | libboost-dev, libboost-filesystem-dev, libboost-program-options-dev, libboost-system-dev, libboost-thread-dev

cmake

Build management tool; v3.12 or higher recommended. http://www.cmake.org/ | cmake

cxxtest

Unit test framework https://cxxtest.com/ | apt-get install cxxtest

Optional Prerequisites

The following are optional, but are strongly recommended, as they result in "pretty" stack traces, which result in far more useful and readable stack traces. These are requires, and not really optional, if you are a regular OpenCog developer.

binutils BFD library

The GNU binutils linker-loader, ahem, cough, "Binary File Description". http://gnu.org/s/binutils | binutils-dev The linker-loader understands calling conventions.

iberty

The GNU GCC compiler tools libiberty component. http://gcc.gnu.org | libiberty-dev The GCC compiler, and iberty in particular, know stack traces.

doxygen

Documentation generator under GNU General Public License http://www.stack.nl/~dimitri/doxygen/ | doxygen Generates code documentation

Building Cogutil

Perform the following steps at the shell prompt:

    cd to project root dir
    mkdir build
    cd build
    cmake ..
    make

Libraries will be built into subdirectories within build, mirroring the structure of the source directory root.

Unit tests

To build and run the unit tests, from the ./build directory enter (after building opencog as above):

    make check

Install

After building, you MUST install the utilities!

    sudo make install