|
1 | | -# libfprint |
2 | 1 |
|
3 | | -libfprint is part of the fprint project: |
4 | | -https://fprint.freedesktop.org/ |
| 2 | + |
| 3 | +<div align="center"> |
| 4 | + |
| 5 | +# LibFPrint |
| 6 | + |
| 7 | +*LibFPrint is part of the **[FPrint][Website]** project.* |
| 8 | + |
| 9 | +<br/> |
| 10 | + |
| 11 | +[![Button Website]][Website] |
| 12 | +[![Button Documentation]][Documentation] |
| 13 | + |
| 14 | +[![Button Supported]][Supported] |
| 15 | +[![Button Unsupported]][Unsupported] |
| 16 | + |
| 17 | +[![Button Contribute]][Contribute] |
| 18 | +[![Button Contributors]][Contributors] |
| 19 | + |
| 20 | +</div> |
5 | 21 |
|
6 | 22 | ## History |
7 | 23 |
|
8 | | -libfprint was originally developed as part of an academic project at the |
9 | | -University of Manchester with the aim of hiding differences between different |
10 | | -consumer fingerprint scanners and providing a single uniform API to application |
11 | | -developers. The ultimate goal of the fprint project is to make fingerprint |
12 | | -scanners widely and easily usable under common Linux environments. |
| 24 | +**LibFPrint** was originally developed as part of an |
| 25 | +academic project at the **[University Of Manchester]**. |
| 26 | + |
| 27 | +It aimed to hide the differences between consumer |
| 28 | +fingerprint scanners and provide a single uniform |
| 29 | +API to application developers. |
| 30 | + |
| 31 | +## Goal |
13 | 32 |
|
14 | | -The academic university project runs off a codebase maintained separately |
15 | | -from this one, although I try to keep them as similar as possible (I'm not |
16 | | -hiding anything in the academic branch, it's just the open source release |
17 | | -contains some commits excluded from the academic project). |
| 33 | +The ultimate goal of the **FPrint** project is to make |
| 34 | +fingerprint scanners widely and easily usable under |
| 35 | +common Linux environments. |
18 | 36 |
|
19 | 37 | ## License |
20 | 38 |
|
21 | | -THE UNIVERSITY OF MANCHESTER DOES NOT ENDORSE THIS THIS SOFTWARE RELEASE AND |
22 | | -IS IN NO WAY RESPONSIBLE FOR THE CODE CONTAINED WITHIN, OR ANY DAMAGES CAUSED |
23 | | -BY USING OR DISTRIBUTING THE SOFTWARE. Development does not happen on |
24 | | -university computers and the project is not hosted at the university either. |
| 39 | +`Section 6` of the license states that for compiled works that use |
| 40 | +this library, such works must include **LibFPrint** copyright notices |
| 41 | +alongside the copyright notices for the other parts of the work. |
| 42 | + |
| 43 | +**LibFPrint** includes code from **NIST's** **[NBIS]** software distribution. |
| 44 | + |
| 45 | +We include **Bozorth3** from the **[US Export Controlled]** |
| 46 | +distribution, which we have determined to be fine |
| 47 | +being shipped in an open source project. |
| 48 | + |
| 49 | +<br/> |
| 50 | + |
| 51 | +<div align="right"> |
| 52 | + |
| 53 | +[![Badge License]][License] |
| 54 | + |
| 55 | +</div> |
| 56 | + |
| 57 | + |
| 58 | +<!-----------------------------------------------------------------------------> |
| 59 | + |
| 60 | +[Documentation]: https://fprint.freedesktop.org/libfprint-dev/ |
| 61 | +[Contributors]: https://gitlab.freedesktop.org/libfprint/libfprint/-/graphs/master |
| 62 | +[Unsupported]: https://gitlab.freedesktop.org/libfprint/wiki/-/wikis/Unsupported-Devices |
| 63 | +[Supported]: https://fprint.freedesktop.org/supported-devices.html |
| 64 | +[Website]: https://fprint.freedesktop.org/ |
25 | 65 |
|
26 | | -For more information on libfprint, supported devices, API documentation, etc., |
27 | | -see the homepage: |
28 | | -https://fprint.freedesktop.org/ |
| 66 | +[Contribute]: ./HACKING.md |
| 67 | +[License]: ./COPYING |
29 | 68 |
|
30 | | -libfprint is licensed under the GNU LGPL version 2.1. See the COPYING file |
31 | | -for the license text. |
| 69 | +[University Of Manchester]: https://www.manchester.ac.uk/ |
| 70 | +[US Export Controlled]: https://fprint.freedesktop.org/us-export-control.html |
| 71 | +[NBIS]: http://fingerprint.nist.gov/NBIS/index.html |
32 | 72 |
|
33 | | -Section 6 of the license states that for compiled works that use this |
34 | | -library, such works must include libfprint copyright notices alongside the |
35 | | -copyright notices for the other parts of the work. We have attempted to |
36 | | -make this process slightly easier for you by grouping these all in one place: |
37 | | -the AUTHORS file. |
38 | 73 |
|
39 | | -libfprint includes code from NIST's NBIS software distribution: |
40 | | -http://fingerprint.nist.gov/NBIS/index.html |
41 | | -We include bozorth3 from the US export controlled distribution. We have |
42 | | -determined that it is fine to ship bozorth3 in an open source project, |
43 | | -see https://fprint.freedesktop.org/us-export-control.html |
| 74 | +<!---------------------------------[ Badges ]----------------------------------> |
44 | 75 |
|
45 | | -## Historical links |
| 76 | +[Badge License]: https://img.shields.io/badge/License-LGPL2.1-015d93.svg?style=for-the-badge&labelColor=blue |
46 | 77 |
|
47 | | -Older versions of libfprint are available at: |
48 | | -https://sourceforge.net/projects/fprint/files/ |
49 | 78 |
|
50 | | -Historical mailing-list archives: |
51 | | -http://www.reactivated.net/fprint_list_archives/ |
| 79 | +<!---------------------------------[ Buttons ]---------------------------------> |
52 | 80 |
|
53 | | -Historical website: |
54 | | -http://web.archive.org/web/*/https://www.freedesktop.org/wiki/Software/fprint/ |
| 81 | +[Button Documentation]: https://img.shields.io/badge/Documentation-04ACE6?style=for-the-badge&logoColor=white&logo=BookStack |
| 82 | +[Button Contributors]: https://img.shields.io/badge/Contributors-FF4F8B?style=for-the-badge&logoColor=white&logo=ActiGraph |
| 83 | +[Button Unsupported]: https://img.shields.io/badge/Unsupported_Devices-EF2D5E?style=for-the-badge&logoColor=white&logo=AdBlock |
| 84 | +[Button Contribute]: https://img.shields.io/badge/Contribute-66459B?style=for-the-badge&logoColor=white&logo=Git |
| 85 | +[Button Supported]: https://img.shields.io/badge/Supported_Devices-428813?style=for-the-badge&logoColor=white&logo=AdGuard |
| 86 | +[Button Website]: https://img.shields.io/badge/Homepage-3B80AE?style=for-the-badge&logoColor=white&logo=freedesktopDotOrg |
0 commit comments