
Copyright (C) 2009-2011 Institute for System Programming, RAS
Copyright (C) 2011-2015 Andrey Ponomarenko's ABI Laboratory
All rights reserved.


RELEASE INFORMATION

Project:           API Sanity Checker
Version:           1.98.7
Date:              2015-09-08


This file explains how to install and setup environment
for the tool in your computer.


Content:

   1. Requirements for Linux and FreeBSD
   2. Requirements for Mac OS X
   3. Requirements for MS Windows
   4. Configuring and Installing
   5. Running the Tool


1. REQUIREMENTS FOR LINUX AND FREEBSD
=====================================

   1. ABI Compliance Checker (1.98.7 or newer)
   2. G++ (3.0-4.7, 4.8.3, 4.9 or newer)
   3. GNU Binutils (c++filt, readelf, objdump)
   4. Perl 5 (5.8 or newer)
   5. Ctags (5.8 or newer)



2. REQUIREMENTS FOR MAC OS X
============================

   1. ABI Compliance Checker (1.98.7 or newer)
   2. Xcode (gcc, c++filt, nm)
   3. Ctags (5.8 or newer)



3. REQUIREMENTS FOR MS WINDOWS
==============================

   1. ABI Compliance Checker (1.98.7 or newer)
   2. MinGW (3.0-4.7, 4.8.3, 4.9 or newer)
   3. MS Visual C++ (dumpbin, undname, cl)
   4. Active Perl 5 (5.8 or newer)
   5. Ctags (5.8 or newer)

3.1 Setup environment

   1. Add tool locations to the PATH environment variable
   2. Run vsvars32.bat script (C:\Microsoft Visual Studio 9.0\Common7\Tools\)



4. CONFIGURING AND INSTALLING
===================================================

   This command will install an api-sanity-checker program in the
   PREFIX/bin system directory:

     sudo make install prefix=PREFIX [/usr, /usr/local, ...]

4.1 Remove

     sudo make uninstall prefix=PREFIX



5. RUNNING THE TOOL
===================

   1. Create an XML-descriptor
      for your library (VERSION.xml):

            <version>
                1.0
            </version>

            <headers>
                /path1/to/header(s)/
                /path2/to/header(s)/
                   ...
            </headers>

            <libs>
                /path1/to/library(ies)/
                /path2/to/library(ies)/
                   ...
            </libs>

   2. api-sanity-checker -lib NAME -d VERSION.xml -gen -build -run
   3. For advanced usage, see doc/Readme.html or --help option



Enjoy!
