# OpenLibraries v0.1.0 Release Notes

1. About
2. Download and Installation
3. Getting Started
4. Troubleshooting
5. FAQ

## 1. About

Welcome to the OpenLibraries! A unified framework to develop real-time editing, visual effects and rich-media applications.

OpenLibraries are free to be applied for any purpose, including commercial usage and distribution. It's open-source software, released under LGPL. OpenLibraries are a true community effort and anyone is welcome to participate.

back to top

## 2. Download and Installation

###

### Downloading:

Installers for Windows and Linux distributions such as Fedora Core 4 and SUSE 10 are available from both the OpenLibraries web site http://www.openlibraries.org and from the OpenLibraries SourceForge web site. Other distributions can use the src rpm or a tarball.

### Installation notes:

Windows: the .msi installer handles both the runtime and development environment needed to run applications based on the OpenLibraries. Additionally, it sets your PATH environment variable. The installer is self contained and it doesn't install any files outside its installation directory.

Linux: the linux RPMs can be used to install both the runtime and development versions. Additionally, an optional RPM is available that includes sample media files.

OSX: there is no installer for OSX, although the OpenLibraries are supported on Tiger (10.4).

Source: source code tarballs are available from the OpenLibraries SourceForge web site and the source code can also be downloaded from the CVS repository:

1. cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/openlibraries login
2. cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/openlibraries co -P openlibraries

or, if running on Windows, with a CVS client such as TortoiseCVS.

To build the libraries Visual Studio solution files, XCode 2.1 projects, and autoconf based scripts are provided depending on each platform. The libraries depend heavily on Boost and GLEW.

back to top

## 3. Getting Started

The best way of getting started as a developer is to download the source code and have a look at the test directory to see how they are being used. It is our intention to provide full developer documentation. Although much code has been written some of it is not fully featured and is effectively entry point code for add-ons and more advanced features. Eventually all of it will be written hopefully with the help of community effort.

###

back to top

## 5. Troubleshooting

### The Bug Tracker

All bug reports will be followed and taken very seriously. There is no excuse for not reporting a bug. If something doesn't work tell us using the bug tracker in SourceForge or in the OpenLibraries web site forums.

### The Fixed Function Pipeline

The OpenLibraries was primarily designed to take advantage of modern GPUs. Most of its functionality is based on programmable shaders, most notably by means of the OpenGL Shading Language and in the future Cg and CgFX. However, there is initial support to fallback to the fixed function pipeline when possible. Initial means that some functionality may not be available or simply buggy. Please help us fix these problems by submitting patches (the best way of solving bugs), or your original files or test samples that cause the erratic behaviour.

###

###

###

###

back to top

## 6. FAQ

1. What's the relationship between Jahshaka and OpenLibraries?

### What's the relationship between Jahshaka and the OpenLibraries?:

We're it! The OpenLibraries project forms the technological foundation for Jahshaka.

Thanks for reading, we hope you enjoy the OpenLibraries project!

Document version 1.0, November 2005

back to top