INSTALL

Copyright (C) 2011-2018 Andrey Ponomarenko's ABI Laboratory

All rights reserved.


RELEASE INFORMATION

Project:           Java API Compliance Checker (JAPICC)
Version:           2.3
Date:              August 30, 2017


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


Content:

   1. Requirements for Linux, FreeBSD and Mac OS X
   2. Requirements for MS Windows
   3. Configure and Install
   4. Usage
   5. Advanced Usage


1. REQUIREMENTS FOR LINUX, FREEBSD and MAC OS X
===============================================

   1. JDK or OpenJDK - development files (javap, javac, jar, jmod)
   2. Perl 5 (5.8 or newer)



2. REQUIREMENTS FOR MS WINDOWS
==============================

   1. JDK or OpenJDK (javap, javac, jar, jmod)
   2. Active Perl 5 (5.8 or newer)



3. CONFIGURE AND INSTALL
========================

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

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

3.1 Remove

     sudo make uninstall prefix=PREFIX



4. USAGE
========

   1. japi-compliance-checker OLD.jar NEW.jar
   2. japi-compliance-checker OLD.jmod NEW.jmod



5. ADVANCED USAGE
=================

   1. Create XML-descriptors for two versions
      of a library (OLD.xml and NEW.xml):
            <version>
                1.0
            </version>
    
            <archives>
                /path1/to/JAR(s) OR JMOD(s)/
                /path2/to/JAR(s) OR JMOD(s)/
                ...
            </archives>

   2. japi-compliance-checker -lib NAME -old OLD.xml -new NEW.xml
   3. For advanced usage, see output of -help option.



Enjoy!