Near Field Communication manager
********************************

Copyright (C) 2011  Intel Corporation. All rights reserved.


Compilation and installation
============================

In order to compile neard you need following software packages:
	- GCC compiler
	- D-Bus library
	- GLib library
	- Netlink (libnl) library, version 3, 2, or 1.

neard uses the Meson build system and requires at least version 1.1.

To configure run:
	meson setup builddir --prefix=/usr

Meson automatically searches for all required components and packages.

To compile and install run:
	meson compile -C builddir
	meson install -C builddir

Configuration and options
=========================

By default all neard plugins and features are built in. They can be
adjusted with the following configuration options, passed as
-Doption=value to meson setup (or changed later with meson configure):

	-Dnfctypes=nfctype1,nfctype2,nfctype3,nfctype4,nfctype5

		Select which NFC Forum tag types (1 to 5) to support.

	-Dp2p=true|false

		Enable or disable support for peer to peer mode.

	-Dese=true|false

		Enable or disable embedded Secure Element support.

	-Dsystemd=auto|enabled|disabled

		Install the systemd service file.

	-Dtools=true|false

		Build testing tools (nfctool, nciattach).

	-Dtest=true|false

		Install test/example scripts.

Bugs and contributing
=====================

Please send bug reports to mailing list:
	oe-linux-nfc@lists.linux.dev
or via issues on GitHub:
	https://github.com/linux-nfc/neard/issues

The project development happens on GitHub:
	https://github.com/linux-nfc/neard

However for historical reasons the releases are also mirrored on kernel.org
repository:
	https://git.kernel.org/pub/scm/network/nfc/neard.git/

Contributions can come in a form of patches sent to
oe-linux-nfc@lists.linux.dev or GitHub pull requests on mentioned GitHub
repository.

See also HACKING and doc/coding-style.txt files.