
All content on this website (including text, images, source
code and any other original works), unless otherwise noted,
is licensed under a Creative Commons License.

http://creativecommons.org/licenses/by-nc-sa/2.5/

Copyright (C) Open-Xchange Inc., 2006-2012
Mail: info@open-xchange.com

@author Daniel Rentz <daniel.rentz@open-xchange.com>

===============================================================================

This package contains icon source files and build scripts needed to create the
image sets and LESS code for all icons used in the OX Documents applications.



1 Installation
==============

ImageMagick is used to generate the image sets from the single icon source
files.

 
1.1 Install ImageMagic (Linux/Solaris/Mac)
------------------------------------------

- Download the appropriate installation archive from

    ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/

- Unpack the archive to an arbitrary location:

    cd /path/to/installation/of/imagemagick
    gzip -dc /path/to/ImageMagick-***.tar.gz | tar -xf -

- Add the MAGICK_HOME environment variable with the installation path (e.g. in
/etc/profile):

    export MAGICK_HOME=/path/to/installation/of/imagemagick

 
1.2 Install ImageMagic (Windows)
--------------------------------

- Download the installation ZIP archive (!) from

    ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/

- Unpack the archive to an arbitrary location.

- Add the MAGICK_HOME environment variable with the installation path to the
system environment:

    MAGICK_HOME = C:\path\to\installation\of\imagemagick



2 Add or Change Icons
=====================

- Copy all new or changed icon files to the sub directory "images".

- Adjust icon definitions in the file "icons.txt". See the descriptions in the
file for syntax details.



3 Build
=======

- Open a console, change to the "icons" directory containing this README file,
and call the appropriate build script for the current operating system
(./build.sh on Linux/Solaris/Mac, build.bat on Windows).

- Copy the files generated in the "tmp" sub directory to the OX Documents
framework/view directory (currently web/ui/apps/io.ox/office/framework/view).
    
- Build the frontend.

