INSTALL.TXT

############################################################################
#   Copyright 2007,2008 Impinj, Inc.
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#
############################################################################

/** @file INSTALL.TXT
 ** @brief contains instructions on installing and building the LTKCPP

INSTALLING AND BUILDING THE LLRP Tool Kit for C++
Last updated 28 Jan 2008

INTRODUCTION
============

These are the instructions for obtaining and building
the LLRP Tool Kit for C++ (LTKCPP) on Linux and
on Windows Visual Studio.

The most recent versions of and news about the
LLRP Tool Kit is available on SourceForge.net

    http://sourceforge.net/projects/llrp-toolkit/




LINUX PREREQUISITES
===================

You need:
    1) A Linux system
    2) gcc(1) and make(1) installed including the C++
       libraries and header files
    3) The LTK distribution




WINDOWS PREREQUISITES
=====================

You need:
    Widows XP or later
    Visual Studio 2003 or later
    xlstproc.exe (http://www.zlatkovic.com/libxml.en.html)
    The LTK distribution




OBTAIN THE LTK DISTRIBUTION USING ANONYMOUS CVS FROM LINUX
==========================================================

Using anonymous CVS, obtain the LLRP Tool Kit
distribution from SourceForge.net

   cvs -d:pserver:anonymous@llrp-toolkit.cvs.sourceforge.net:/cvsroot/llrp-toolkit login

[press ENTER when prompted for the password]
 
   cvs -z3 -d:pserver:anonymous@llrp-toolkit.cvs.sourceforge.net:/cvsroot/llrp-toolkit co -P LTK




OBTAIN THE LTK DISTRIBUTION AS A ZIP FILE
=========================================

TODO




BUILD ON LINUX
==============

    cd LTK/LTKCPP
    make




VERIFICATION ON LINUX
=====================

Try dx101, the stand-alone self-test. It needs no reader.

    cd LTK/LTKCPP/Tests
    sh RUN101

Expect this output

    ./dx101 ../../Tests/dx101/dx101_a_in.bin > dx101_out.tmp
    PASSED

If you have a LLRP reader available, you may want to try dx201

    cd LTK/LTKCPP/Tests
    dx201 -v MyReaderHostName

or try example1

    cd LTK/LTKCPP/Examples
    example1 -v MyReaderHostName




BUILD ON WINDOWS VISUAL STUDIO
==============================

Start a command (DOS prompt) Window

Run the script that generates code. This needs xsltproc.exe.
See notes inside of gencode.bat for obtaining xsltproc.exe.
It's easy and free of charge.

    cd LTK\LTKCPP\Library
    gencode.bat

Use the Windows explorer to find folder

    LKT\LTKCPP\VS_LTKCPP

Double click on the Solution file

    VS_LTKCPP.sln

Visual Studio should start

Click on the Build menu, then click on menu entry Build Solution




VERIFICATION ON WINDOWS
=======================

Start a command (DOS prompt) Window

Try dx101, the stand-alone self-test. It needs no reader.

    cd LTK\LTKCPP\VS_LTKCPP\dx101\Debug

Run this command

    dx101 ..\..\..\..\Tests\dx101\dx101_a_in.bin

All this can do is show you that the build of dx101
succeeded. The output should textually compare to
......\dx101_a_out.txt. But there is no ready utility
to do the comparisson.

If you have a LLRP reader available, you may want to try dx201

    cd LTK\LTKCPP\VS_LTKCPP\dx201\Debug
    dx201 /v MyReaderHostName

or try example1

    cd LTK\LTKCPP\VS_LTKCPP\example1\Debug
    example1 /v MyReaderHostName




FOR FURTHER INFORMATION OR TO GET HELP
======================================

Visit the LLRP Tool Kit project on SourceForge.net

**/