From 22cee9741f68f4d982c57c45e8a4d20d177ab217 Mon Sep 17 00:00:00 2001 From: developer1 Date: Tue, 18 Jul 2017 10:37:12 +0200 Subject: [PATCH] Added README --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..832709c --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# uFR Series libraries + +Scope of this project are libraries used with uFR Series devices and SDK examples. +Libraries are supported at following platforms: +Windows 32 and 64 bit (static and dynamic) +Windows ARM +Linux 32 and 64 bit (dynamic only) +Linux ARM and ARM-HF (dynamic only) +Mac OSX 32 and 64 bit (dynamic only) + + + +## Getting Started + +Download project, choose appropriate architecture and place a library in appropriate directory. +Consult documentation for API reference. For quick insight and functions' prototypes, check /include/ufCoder.h header file. + + +### Prerequisites + +uFR Series reader. + + +## License + +This project is licensed under the ..... License - see the [LICENSE.md](LICENSE.md) file for details + +## Acknowledgments + +* Libraries are specific to mentioned hardware ONLY and some other hardware might have different approach, please bear that in mind. + + -- GitLab