STYLE: Add a lot of comments for the CMake build system
[openjpeg.git] / README.osx
1 Release Notes
2 --------------
3 This version of the library has been tested under OSX 10.3 using gcc 3.3.
4
5 While the makefiles will make a .dylib and a .a, it is recommended to simply staticly link with the .a file.
6
7 Installation
8 ------------
9 Note: You will need to have root privileges in order to install the library in the /usr/lib directory.
10 The installation process is as simple as this : 
11 1) Enter the OpenJPEG directory
12 2) Build the distribution : 
13 make osx
14 make osxinstall
15 3) Clean all files produced during the build process
16 make osxclean
17
18 Simple codec compilation
19 ------------------------
20 Once you've built the library, you might want to test it with a basic codec. To do this, go to the codec directory and use one of the following commands to build an encoder and decoder respectively:
21
22 gcc convert.c image_to_j2k.c -o image_to_j2k -lopenjpeg -I ../libopenjpeg/ -lm
23 gcc convert.c j2k_to_image.c -o j2k_to_image -lopenjpeg -I ../libopenjpeg/ -lm
24
25 You should add '-L..' to those lines if you did not use the 'osxinstall' target (and the 'osxclean' target neither...).