readme-old.md

• Download
• Checking out
• Updating submodules
• Building the source code
• Building the API documentation with Doxygen

Jamoma is a set of libraries for live (real-time) processing of multi-media. This repository is the master project for the Jamoma platform, and contains several submodules:

#Download Jamoma

If you just want to download and use Jamoma with Cycling'74 Max, you can find the latest version at the main Jamoma website. The Jamoma UserLibs, which contains various development projects by Jamoma users, can be downloaded the same place. The source code for UserLibs can be retrieved as a GitHub repository.

#Checking out the source code

In order to download and use the source code, you first need to ensure that you have Git and Ruby installed.

Start out by cloning this repository:

git clone https://github.com/jamoma/Jamoma.git

Next you need to retrieve all submodules:

cd  Jamoma
git submodule update --init
git checkout dev
git pull
git submodule update

This will bring you into "no branch" of the submodules, so you'll need to check them out to the desired branches, e.g.:

git submodule foreach git checkout dev

##Update submodules

All sources needed to build Jamoma can be updated to last version following these steps:

1.From Terminal or the cygwin window (on Windows), go to the main Jamoma directory, then make sure all submodules are on the 'dev' branch :

git submodule foreach git checkout dev

2.Then pull all changes from the repository:

git submodule foreach git pull

##Building the source code

The Jamoma framework can be easily compiled using a Ruby script, or CMake scripts. To do so, please follow these steps:

1.From Terminal or the cygwin window (on Windows), go to the main Jamoma directory by running the following command :

cd Jamoma

2.Run the Ruby "build.rb" script running the following command:

ruby build.rb Deployment clean

Alternatively, if you want a developer build rather than a distributable release version, you may do it so with the following command:

ruby build.rb Development

##Building the API documentation with Doxygen

The API that documents our C++ source code is generated by Doxygen. A configuration file is included in this repository (Jamoma_doxyfile.txt) that can easily be used with the GUI front-end available on the Doxygen website. When it is run, it will search source files in both the Core (../Core/) and Implementations (../Implementations/) repositories for formatted comments found in individual files. These are then rendered as HTML in a new build folder (Doxygen/build/). It is STRONGLY advised that you delete this folder between attempts to render the content.

For more information on Doxygen, visit: http://www.stack.nl/~dimitri/doxygen/index.html

#Contributing

If you want to contribute to the development of Jamoma, the recommended workflow is described here.