FreeJ installation instructions
===================================

*** x86 PC (for Darwin/OSX see README.OSX)


[*] be sure to have all the required libraries and tools

- A working GNU/Linux system with X or framebuffer video

- SDL libraries http://www.libsdl.org

- PNG library (compile with _ZLIB_ support) http://libpng.org

[*] check the optional libraries you need for certain features

== to play with truetype rendered text install:
   Freetype2 http://freetype.org

== to have some more assembler mmx optimized filters you need NASM:
   NASM netwide assembler compiler http://sf.net/projects/nasm
   then go in the filters/nasm-x86 and type make!
   copy by hand the *.so filters in a ~/.freej/ directory in your home



[*] then you are ready to compile!

== download freej latest stable version from http://ftp.dyne.org/freej
   extract the source archive and compile it:
   $ tar xvfz freej.tar.gz
   $ cd freej
    (if you are reading this file from the sourcecode, start from here)
   $ ./configure
   $ make
   # make install

   this will install effect plugins into /usr/local/lib/freej/
   the freej binary in /usr/local/bin/
  (or any other prefix you configured instead of the default /usr/local)

   $ freej [enter]

   and you should see.



:: INSTALL FROM DEBIAN PACKAGES

You can do 'apt-get install freej' and you will have a precompiled FreeJ 
Anyway to squeeze the best out of your box you want to compile this
software with machine specific optimizations!
The source configure script guesses the best compiler optimization flags
for your CPU.



If you have problems, you are welcome to ask on the mailinglist for
help, there you will probably find somebody to help you.

Please try to not mix your problems with FreeJ's bugs.

If you find bugs, you are welcome to report them in the bugtracking
system on http://bugs.dyne.org

$Id: INSTALL 615 2005-08-04 16:55:37Z jaromil $

