Installing Rudiments Supported Platforms

Rudiments should build on relatively modern versions of Linux, Unix or Unix-like systems including Solaris, FreeBSD, NetBSD, OpenBSD, Mac OS X, Haiku and Cygwin.

x86 and x86_64 platforms are supported, as are non-x86 architectures such as ARM, Sparc, Mips, PPC and others.

uClibc/linux-based systems are also supported.

Most of Rudiments builds natively on Windows using Visual Studio. Everything isn't implemented yet, but there is quite a bit that does work.

Prerequisites

To build on a unix-like platform, Rudiments requires a working compiler toolchain and the make utility.

If OpenSSL and/or the Perl Compatible Regular Expression libraries are present then the build process will detect them and include support for them but they are not required.

To build natively on Windows, you need to install Microsoft Visual Studio or Microsoft Visual Studio Express.


Installation on Linux, Unix or Unix-like Platforms

Downloading Rudiments

You can download the most current source distribution of Rudiments from http://rudiments.sourceforge.net.

For Linux, Unix or Cygwin installations, download the tar.gz file.

Extracting Rudiments

To extract the distribution on Unix or Linux, move the file to a location on your machine that you have read/write access to and execute the following commands:

gunzip rudiments-X.XX.tar.gz
tar xf rudiments-X.XX.tar

(Where X.XX is replaced with the version of Rudiments that you downloaded.)

This will create a rudiments-X.XX directory.

Building Rudiments

To build Rudiments, navigate to the directory that was created by the extraction and execute the following commands:

configure
make

The configure script takes lots of command line options, most of which tell it which features to enable or disable or where to find prerequisite software in case any of it is installed in non-standard locations. It also takes the --prefix option in case you want to install it somewhere other than /usr/local/firstworks. For example:

configure --prefix=/usr/local

This invocation would cause the libraries to be installed in /usr/local/lib, the header files in /usr/local/include, the binaries and scripts to be installed in /usr/local/bin, etc.

There are also options for using cross-compilers and enabling debug and profiling. To see the full list of available options, run:

configure --help

There are several things to note when using Cygwin.

Installing Rudiments

By default, on Unix or Linux, everything is installed under /usr/local/firstworks by default. You should either create that directory and give yourself full access permissions or install as root.

To install Rudiments run:

make install

To uninstall Rudiments run:

make uninstall

Installation on Windows

Downloading Rudiments

You can download the most current source distribution of Rudiments from http://rudiments.sourceforge.net.

If you intend to build on Unix, Linux or Cygwin then download the tar.gz file. For a native Windows installation, download the zip file.

Extracting Rudiments

To extract the distribution, move the zip file to your desktop or a location on your machine that you have read/write access, right click on the file and select "Extract All".

This will create a rudiments-X.XX directory where X.XX is replaced with the rudiments version number.

Building Rudiments

To build Rudiments natively on Windows, open the Visual Studio Command Prompt and navigate to the directory that was created when Rudiments was extracted.

There should be a file named make.batch in that directory. Rename this file to make.bat. It is named with the .batch extension because various mail services don't allow .bat files to be emailed around, even if they are inside of an archive. To get around this, the file must manually be renamed.

There are 4 build options. Rudiments can be built as 32-bit or 64-bit binaries, and with or without Common Language Runtime (CLR) support. There are advantages and disadvantages to building each way.

To build 32-bit without CLR support, run:

make

To build 32-bit with CLR support, run:

make clr

To build 64-bit without CLR support, run:

make 64

To build 64-bit with CLR support, run:

make clr64
Installing Rudiments

By default, on Windows, everything is installed under C:\Program Files\Firstworks for 64-bit builds or C:\Program Files (x86)\Firstworks for 32-bit builds. You should either create that directory and give yourself full access permissions or install as Administrator.

To install 32-bit Rudiments run:

make install

To install 64-bit Rudiments run:

make install64

To uninstall Rudiments run:

make uninstall