| 1 | # Adafruit-PN532 [](https://github.com/adafruit/Adafruit-PN532/actions) |
| 2 | |
| 3 | |
| 4 | This is a library for the Adafruit PN532 NFC/RFID breakout boards |
| 5 | This library works with the Adafruit NFC breakout |
| 6 | |
| 7 | * https://www.adafruit.com/products/364 |
| 8 | |
| 9 | Check out the links above for our tutorials and wiring diagrams |
| 10 | These chips use I2C or SPI to communicate. |
| 11 | |
| 12 | # Dependencies |
| 13 | * [Adafruit_BusIO](https://github.com/adafruit/Adafruit_BusIO) |
| 14 | |
| 15 | |
| 16 | # Contributing |
| 17 | |
| 18 | Contributions are welcome! Please read our [Code of Conduct](https://github.com/adafruit/Adafruit-PN532/blob/master/CODE_OF_CONDUCT.md>) |
| 19 | before contributing to help this project stay welcoming. |
| 20 | |
| 21 | ## Documentation and doxygen |
| 22 | Documentation is produced by doxygen. Contributions should include documentation for any new code added. |
| 23 | |
| 24 | Some examples of how to use doxygen can be found in these guide pages: |
| 25 | |
| 26 | https://learn.adafruit.com/the-well-automated-arduino-library/doxygen |
| 27 | |
| 28 | https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips |
| 29 | |
| 30 | ## Formatting and clang-format |
| 31 | This library uses [`clang-format`](https://releases.llvm.org/download.html) to standardize the formatting of `.cpp` and `.h` files. |
| 32 | Contributions should be formatted using `clang-format`: |
| 33 | |
| 34 | The `-i` flag will make the changes to the file. |
| 35 | ```bash |
| 36 | clang-format -i *.cpp *.h |
| 37 | ``` |
| 38 | If you prefer to make the changes yourself, running `clang-format` without the `-i` flag will print out a formatted version of the file. You can save this to a file and diff it against the original to see the changes. |
| 39 | |
| 40 | Note that the formatting output by `clang-format` is what the automated formatting checker will expect. Any diffs from this formatting will result in a failed build until they are addressed. Using the `-i` flag is highly recommended. |
| 41 | |
| 42 | ### clang-format resources |
| 43 | * [Binary builds and source available on the LLVM downloads page](https://releases.llvm.org/download.html) |
| 44 | * [Documentation and IDE integration](https://clang.llvm.org/docs/ClangFormat.html) |
| 45 | Adafruit invests time and resources providing this open source code, |
| 46 | please support Adafruit and open-source hardware by purchasing |
| 47 | products from Adafruit! |
| 48 | |
| 49 | Written by Limor Fried/Ladyada & Kevin Townsend for Adafruit Industries. |
| 50 | BSD license, check license.txt for more information |
| 51 | All text above must be included in any redistribution |
| 52 | |
| 53 | To install, use the Arduino Library Manager and search for "Adafruit PN532" and install the library. Adafruit BusIO library is also required |