Jamoma repository for documentation
XSLT Max Ruby CSS C++ Makefile
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Examples/sweepy
Max
Modular/Video/Library
Tools
.gitignore
readme.md

readme.md

#JAMOMA DOCUMENTATION REPOSITORY

This is the repository for everything documentation-related. Here are hosted various pieces of reference files, tutorials, etc. for Max implementation as well as some documentation on Jamoma API

##BUILDING THE API DOCUMENTATION W/ DOXYGEN

###QUICK INSTRUCTIONS

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

##WRITING DOCUMENTATION ###PREFERRED FORMAT

Max's refpages are written in yaml. There are automatically converted as xml files by the build.rb script. Use the provided template (./Tools/j.object-template.maxref.yml) to get you started.

Max's tutorials and vignette are written as Textile format as much as possible since it proves to be light, easy to maintain and can be exported in various format. A template is also provided (./Tools/TextileTemplate.textile).

###REGARDING THE USE OF BRANCHES

The 'master' branch is where all documents ready to be published are to reside. Note that all materials in the master branch are automatically converted from textile to html when building the Jamoma installer.

Thus, when starting to work on a tutorial or documentation bit, it is advised to work on the 'dev' branch or create a specific branch if needed. Once you are done with writing the documentation part, merge the branch into 'master' or use Git 'cherry-pick' command.