Rudiments Guide

Downloading Rudiments:

You can download the most current source distribution of rudiments from http://www.firstworks.com/site/downloads/archive/rudiments-latest.tar.gz.

Unpacking Rudiments:

To unpack the distribution, copy the file to a location on your machine that you have access to and execute the following commands:

This will create a rudiments-X.X directory with include, lib and src directories beneath it.

Compiling Rudiments:

To compile Rudiments, read the INSTALL file, then execute the following commands:

Rudiments should compile and function on other unix-based system using the GNU development system. Other compilers may work too but have not been tested on the current version.

The -pedantic flag must be used with newer GNU compilers.

Upon sucessfull compilation, the lib directory should contain both librudiments.a and librudiments.so.

Installing Rudiments:

To install Rudiments, become root and execute:

By default, everything is installed under /usr/local/firstworks.

To uninstall Rudiments, become root and execute:

Classes:

The rudiments class library consists of several classes. Some are utility classes, others are designed to be base classes for software.

As a rule of thumb, the above base classes should be inherited from and the utility classes should be instantiated as needed.