INSTALL

/*
 * Copyright 2008-2016 Freescale Semiconductor Inc.
 * Copyright 2017-2018 NXP
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *        notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *        notice, this list of conditions and the following disclaimer in the
 *        documentation and/or other materials provided with the distribution.
 *      * Neither the name of the above-listed copyright holders nor the
 *        names of any contributors may be used to endorse or promote products
 *        derived from this software without specific prior written permission.
 *
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

Manual installation for FM library:
   - set PATH and CROSS_COMPILE to point to the cross-toolchain on the host
   - set KERNEL_SRC to point to the root dir. for the kernel/headers (i.e.
   the Linux kernel that's contained in the SDK, not other kernel!)
   - make all: will create the binaries for all platforms
   - make archive: will create the tarball containing all fmlib binaries
   - make install-xxx will:
	* copy binary (libfm-xxx.a) to the ${PREFIX}/lib folder on the target
	root filesystem pointed to by the ${DESTDIR} variable
	* copy headers (include/fmd/ dir.) to the ${PREFIX}/include/fmd/ dir.
	on target rfs
	* copy doc. files to the ${PREFIX}/share/doc/fm-lib-<version> dir
	of the same rfs

'make targets' will display a short usage summary, along with the available
"xxx" variants.

An application that uses this package will have to link with the static
library and include the necessary headers.