Update and rename README to README.md

README

@@ -1,15 +0,0 @@
-The libfreefare project aims to provide a convenient API for Mifare card
-manipulations.
-
-Supported tags:
-  - Mifare Classic 1k
-  - Mifare Classic 4k
-  - Mifare DESFire 2K/4K/8K
-  - Mifare DESFire EV1
-  - Mifare Ultralight
-  - Mifare UltralightC
-
-Supported features:
-  - Mifare Application Directory (MAD) v1
-  - Mifare Application Directory (MAD) v2
-  - Mifare Application Directory (MAD) v3 (part of DESFire support)

README.md

@@ -0,0 +1,80 @@
+# Introduction
+
+The _libfreefare_ project provides a convenient API for MIFARE card manipulations.
+
+It is part of the _nfc-tools_, you can find more info on them on the [nfc-tools wiki](http://nfc-tools.org/).
+
+If you are new to _libfreefare_ or the _nfc-tools_, you should collect useful information on the [project website](http://nfc-tools.org/) and the [dedicated forums](http://www.libnfc.org/community).
+
+# Feature matrix
+## Tags
+| Tag                | Status        |
+|:-------------------|:--------------|
+| MIFARE Classic 1k  | Supported     |
+| MIFARE Classic 4k  | Supported     |
+| MIFARE DESFire 2k  | Supported     |
+| MIFARE DESFire 4k  | Supported     |
+| MIFARE DESFire 8k  | Supported     |
+| MIFARE DESFire EV1 | Supported     |
+| MIFARE Mini        | Not supported |
+| MIFARE Plus S 2k   | Not supported |
+| MIFARE Plus S 4k   | Not supported |
+| MIFARE Plus X 2k   | Not supported |
+| MIFARE Plus X 4k   | Not supported |
+| MIFARE Ultralight  | Supported     |
+| MIFARE UltralightC | Supported     |
+
+## Specifications
+| Specification                         | Status    |
+|:--------------------------------------|:----------|
+| Mifare Application Directory (MAD) v1 | Supported |
+| Mifare Application Directory (MAD) v2 | Supported |
+| Mifare Application Directory (MAD) v3 | Supported (part of Mifare DESFire support) |
+
+# Installation
+You can use released version (see **Download** section) or development version:
+
+First, ensure all dependencies are installed:
+* [libnfc](https://github.com/nfc-tools/libnfc);
+* git;
+* Autotools (autoconf, automake, libtool);
+* OpenSSL development package.
+```
+apt-get install autoconf automake git libtool libssl-dev pkg-config
+```
+
+Clone this repository:
+```
+git clone https://github.com/nfc-tools/libfreefare.git
+cd libfreefare
+```
+
+Before compiling, remember to run:
+```
+autoreconf -vis
+```
+
+You can now compile **libfreefare** the usual autotools way:
+```
+./configure --prefix=/usr
+make
+sudo make install
+```
+
+# Debug
+In order to debug using gdb, you should tune the CFLAGS:
+```
+CFLAGS="-O0 -ggdb" ./configure --prefix=/usr
+make clean all
+```
+
+It is then possible to debug examples using this kind of command from the root of the repository:
+```
+./libtool --mode=execute gdb examples/mifare-classic-write-ndef
+```
+
+If you are only interested in viewing transfert traces between the PCD and the PICC, simply use the `--enable-debug` configure flag:
+```
+./configure --enable-debug
+make clean all
+```